Enum tor_cell::relaycell::msg::AnyRelayMsg

#[non_exhaustive]
pub enum AnyRelayMsg {
    Begin(Begin),
    Data(Data),
    End(End),
    Connected(Connected),
    Sendme(Sendme),
    Extend(Extend),
    Extended(Extended),
    Extend2(Extend2),
    Extended2(Extended2),
    Truncate(Truncate),
    Truncated(Truncated),
    Drop(Drop),
    Resolve(Resolve),
    Resolved(Resolved),
    BeginDir(BeginDir),
    ConnectUdp(ConnectUdp),
    ConnectedUdp(ConnectedUdp),
    Datagram(Datagram),
    EstablishIntro(EstablishIntro),
    EstablishRendezvous(EstablishRendezvous),
    Introduce1(Introduce1),
    Introduce2(Introduce2),
    Rendezvous1(Rendezvous1),
    Rendezvous2(Rendezvous2),
    IntroEstablished(IntroEstablished),
    RendezvousEstablished(RendezvousEstablished),
    IntroduceAck(IntroduceAck),
    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(Truncate)

Partially close a circuit

Truncated(Truncated)

Tell the client that a circuit has been partially closed

Drop(Drop)

Used for padding

Resolve(Resolve)

Launch a DNS request

Resolved(Resolved)

Response to a Resolve message

BeginDir(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 hs only.

Establish Introduction

EstablishRendezvous(EstablishRendezvous)

Available on crate feature hs only.

Establish Rendezvous

Introduce1(Introduce1)

Available on crate feature hs only.

Introduce1 (client to introduction point)

Introduce2(Introduce2)

Available on crate feature hs only.

Introduce2 (introduction point to service)

Rendezvous1(Rendezvous1)

Available on crate feature hs only.

Rendezvous1 (service to rendezvous point)

Rendezvous2(Rendezvous2)

Available on crate feature hs only.

Rendezvous2 (rendezvous point to client)

IntroEstablished(IntroEstablished)

Available on crate feature hs only.

Acknowledgement for EstablishIntro.

RendezvousEstablished(RendezvousEstablished)

Available on crate feature hs only.

Acknowledgment for EstablishRendezvous.

IntroduceAck(IntroduceAck)

Available on crate feature hs only.

Acknowledgement for Introduce1.

Unrecognized(Unrecognized)

An unrecognized command.

Trait Implementations

impl Clone for AnyRelayMsg

fn clone(&self) -> AnyRelayMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnyRelayMsg

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

Formats the value using the given formatter.

impl From<Begin> for AnyRelayMsg

fn from(m: Begin) -> AnyRelayMsg

Converts to this type from the input type.

impl From<BeginDir> for AnyRelayMsg

fn from(m: BeginDir) -> AnyRelayMsg

Converts to this type from the input type.

impl From<ConnectUdp> for AnyRelayMsg

Available on crate feature experimental-udp only.

fn from(m: ConnectUdp) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Connected> for AnyRelayMsg

fn from(m: Connected) -> AnyRelayMsg

Converts to this type from the input type.

impl From<ConnectedUdp> for AnyRelayMsg

Available on crate feature experimental-udp only.

fn from(m: ConnectedUdp) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Data> for AnyRelayMsg

fn from(m: Data) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Datagram> for AnyRelayMsg

Available on crate feature experimental-udp only.

fn from(m: Datagram) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Drop> for AnyRelayMsg

fn from(m: Drop) -> AnyRelayMsg

Converts to this type from the input type.

impl From<End> for AnyRelayMsg

fn from(m: End) -> AnyRelayMsg

Converts to this type from the input type.

impl From<EstablishIntro> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: EstablishIntro) -> AnyRelayMsg

Converts to this type from the input type.

impl From<EstablishRendezvous> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: EstablishRendezvous) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Extend> for AnyRelayMsg

fn from(m: Extend) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Extend2> for AnyRelayMsg

fn from(m: Extend2) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Extended> for AnyRelayMsg

fn from(m: Extended) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Extended2> for AnyRelayMsg

fn from(m: Extended2) -> AnyRelayMsg

Converts to this type from the input type.

impl From<IntroEstablished> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: IntroEstablished) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Introduce1> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: Introduce1) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Introduce2> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: Introduce2) -> AnyRelayMsg

Converts to this type from the input type.

impl From<IntroduceAck> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: IntroduceAck) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Rendezvous1> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: Rendezvous1) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Rendezvous2> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: Rendezvous2) -> AnyRelayMsg

Converts to this type from the input type.

impl From<RendezvousEstablished> for AnyRelayMsg

Available on crate feature hs only.

fn from(m: RendezvousEstablished) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Resolve> for AnyRelayMsg

fn from(m: Resolve) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Resolved> for AnyRelayMsg

fn from(m: Resolved) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Sendme> for AnyRelayMsg

fn from(m: Sendme) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Truncate> for AnyRelayMsg

fn from(m: Truncate) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Truncated> for AnyRelayMsg

fn from(m: Truncated) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Unrecognized> for AnyRelayMsg

fn from(u: Unrecognized) -> AnyRelayMsg

Converts to this type from the input type.

impl RelayMsg for AnyRelayMsg

fn cmd(&self) -> RelayCmd

Return the stream command associated with this message.

fn encode_onto<W>(self, w: &mut W) -> EncodeResult<()>where W: Writer + ?Sized,

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

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

Extract the body of a message with command cmd from reader r.