Enum tor_cell::relaycell::msg::RelayMsg

#[non_exhaustive]
pub enum RelayMsg {
    Begin(Begin),
    Data(Data),
    End(End),
    Connected(Connected),
    Sendme(Sendme),
    Extend(Extend),
    Extended(Extended),
    Extend2(Extend2),
    Extended2(Extended2),
    Truncate,
    Truncated(Truncated),
    Drop,
    Resolve(Resolve),
    Resolved(Resolved),
    BeginDir,
    Unrecognized(Unrecognized),
}

A single parsed relay message, sent or received along a circuit

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Begin(Begin)

Create a stream

Tuple Fields of Begin

0: Begin

Data(Data)

Send data on a stream

Tuple Fields of Data

0: Data

End(End)

Close a stream

Tuple Fields of End

0: End

Connected(Connected)

Successful response to a Begin message

Tuple Fields of Connected

0: Connected

Sendme(Sendme)

For flow control

Tuple Fields of Sendme

0: Sendme

Extend(Extend)

Extend a circuit to a new hop (deprecated)

Tuple Fields of Extend

0: Extend

Extended(Extended)

Successful response to an Extend message (deprecated)

Tuple Fields of Extended

0: Extended

Extend2(Extend2)

Extend a circuit to a new hop

Tuple Fields of Extend2

0: Extend2

Extended2(Extended2)

Successful response to an Extend2 message

Tuple Fields of Extended2

0: Extended2

Truncate

Partially close a circuit

Truncated(Truncated)

Tell the client the a circuit has been partially closed

Tuple Fields of Truncated

0: Truncated

Drop

Used for padding

Resolve(Resolve)

Launch a DNS request

Tuple Fields of Resolve

0: Resolve

Resolved(Resolved)

Response to a Resolve message

Tuple Fields of Resolved

0: Resolved

BeginDir

Start a directory stream

Unrecognized(Unrecognized)

An unrecognized command.

Tuple Fields of Unrecognized

0: Unrecognized

Implementations

impl RelayMsg

pub fn cmd(&self) -> RelayCmd

Return the stream command associated with this message.

pub fn decode_from_reader(c: RelayCmd, r: &mut Reader<'_>) -> Result<Self>

Extract the body of this message from r

pub fn encode_onto(self, w: &mut Vec<u8>)

Encode the body of this message, not including command or length

Trait Implementations

impl Clone for RelayMsg

fn clone(&self) -> RelayMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayMsg

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

Formats the value using the given formatter.

impl<B: Body> From<B> for RelayMsg

fn from(b: B) -> RelayMsg

Performs the conversion.