Struct tor_cell::relaycell::msg::Truncated

pub struct Truncated { /* private fields */ }

A Truncated message is sent to the client when the remaining hops of a circuit have gone away.

NOTE: Current Tor implementations often treat Truncated messages and Destroy messages interchangeably. Truncated was intended to be a “soft” Destroy, that would leave the unaffected parts of a circuit still usable.

Implementations

impl Truncated

pub fn new(reason: DestroyReason) -> Self

Construct a new truncated message.

pub fn reason(self) -> DestroyReason

Get the provided reason to truncate the circuit.

Trait Implementations

impl Body for Truncated

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

Decode a relay cell body from a provided reader.

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

Encode the body of this cell into the end of a writer.

impl Clone for Truncated

fn clone(&self) -> Truncated

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Truncated

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

Formats the value using the given formatter.

impl From<Truncated> for AnyRelayMsg

fn from(m: Truncated) -> AnyRelayMsg

Converts to this type from the input type.

impl RelayMsg for Truncated

fn cmd(&self) -> RelayCmd

Return the stream command associated with this message.

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

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.

impl TryFrom<AnyRelayMsg> for Truncated

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: AnyRelayMsg) -> Result<Truncated>

Performs the conversion.