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,
    ConnectUdp(ConnectUdp),
    ConnectedUdp(ConnectedUdp),
    Datagram(Datagram),
    EstablishIntro(EstablishIntro),
    EstablishRendezvous(EstablishRendezvous),
    Introduce1(Introduce1),
    Introduce2(Introduce2),
    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

Data(Data)

Send data on a stream

End(End)

Close a stream

Connected(Connected)

Successful response to a Begin message

Sendme(Sendme)

For flow control

Extend(Extend)

Extend a circuit to a new hop (deprecated)

Extended(Extended)

Successful response to an Extend message (deprecated)

Extend2(Extend2)

Extend a circuit to a new hop

Extended2(Extended2)

Successful response to an Extend2 message

Truncate

Partially close a circuit

Truncated(Truncated)

Tell the client the a circuit has been partially closed

Drop

Used for padding

Resolve(Resolve)

Launch a DNS request

Resolved(Resolved)

Response to a Resolve message

BeginDir

Start a directory stream

ConnectUdp(ConnectUdp)

Available on crate feature experimental-udp only.

Start a UDP stream.

ConnectedUdp(ConnectedUdp)

Available on crate feature experimental-udp only.

Successful response to a ConnectUdp message

Datagram(Datagram)

Available on crate feature experimental-udp only.

UDP stream data

EstablishIntro(EstablishIntro)

Available on crate feature onion-service only.

Establish Introduction

EstablishRendezvous(EstablishRendezvous)

Available on crate feature onion-service only.

Establish Rendezvous

Introduce1(Introduce1)

Available on crate feature onion-service only.

Introduce1

Introduce2(Introduce2)

Available on crate feature onion-service only.

Introduce2

Unrecognized(Unrecognized)

An unrecognized command.

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>) -> EncodeResult<()>

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

Converts to this type from the input type.