Enum CloseReason 

pub enum CloseReason {
    None = 0,
    Protocol = 1,
    Internal = 2,
    Requested = 3,
    Hibernating = 4,
    ResourceLimit = 5,
    ConnectFailed = 6,
    OrIdentity = 7,
    ChannelClosed = 8,
    Finished = 9,
    Timeout = 10,
    Destroyed = 11,
    NoSuchService = 12,
    Unknown = 13,
}

Reason for closing a circuit or stream.

These codes indicate why a relay closed a circuit or stream. They are used in DESTROY cells and RELAY_END cells.

Variants

Reason	Value	Description
None	0	No reason given
Protocol	1	Tor protocol violation
Internal	2	Internal error
Requested	3	Client sent TRUNCATE command
Hibernating	4	Relay suspended to save bandwidth
ResourceLimit	5	Out of memory, sockets, or circuit IDs
ConnectFailed	6	Unable to reach relay
OrIdentity	7	Connected but OR identity was wrong
ChannelClosed	8	Connection carrying this circuit died
Finished	9	Circuit expired (dirty or old)
Timeout	10	Circuit construction took too long
Destroyed	11	Circuit destroyed without client TRUNCATE
NoSuchService	12	Request for unknown hidden service
Unknown	-	Unrecognized reason

Example

use stem_rs::client::datatype::CloseReason;

let (reason, raw) = CloseReason::get(3);
assert_eq!(reason, CloseReason::Requested);
assert_eq!(format!("{}", reason), "REQUESTED");

Variants

None = 0

No reason given.

Protocol = 1

Tor protocol violation.

Internal = 2

Internal error.

Requested = 3

Client sent a TRUNCATE command.

Hibernating = 4

Relay suspended, trying to save bandwidth.

ResourceLimit = 5

Out of memory, sockets, or circuit IDs.

ConnectFailed = 6

Unable to reach relay.

OrIdentity = 7

Connected, but its OR identity was not as expected.

ChannelClosed = 8

Connection that was carrying this circuit died.

Finished = 9

Circuit has expired for being dirty or old.

Timeout = 10

Circuit construction took too long.

Destroyed = 11

Circuit was destroyed without a client TRUNCATE.

NoSuchService = 12

Request was for an unknown hidden service.

Unknown = 13

Unrecognized reason.

Implementations

impl CloseReason

pub fn get(val: u8) -> (CloseReason, u8)

Converts a raw byte value to a CloseReason and its integer representation.

Arguments

• val - The raw reason byte from the protocol

Returns

A tuple of (CloseReason, u8) where the second element is the original byte value.

pub fn value(&self) -> u8

Returns the integer value for this close reason.

Returns 255 for Unknown reasons.

Trait Implementations

impl Clone for CloseReason

fn clone(&self) -> CloseReason

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CloseReason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for CloseReason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the close reason as its canonical string name.

impl Hash for CloseReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CloseReason

fn eq(&self, other: &CloseReason) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CloseReason

impl Eq for CloseReason

impl StructuralPartialEq for CloseReason