Struct End

pub struct End { /* private fields */ }

An End message tells the other end of the circuit to close a stream.

Note that End messages do not implement a true half-closed state, so after sending an End message each party needs to wait a while to be sure that the stream is completely dead.

Implementations

impl End

pub fn new_misc() -> Self

Make a new END_REASON_MISC message.

Clients send this every time they decide to close a stream.

pub fn new_with_reason(reason: EndReason) -> Self

Make a new END message with the provided end reason.

pub fn new_exitpolicy(addr: IpAddr, ttl: u32) -> Self

Make a new END message with END_REASON_EXITPOLICY, and the provided address and ttl.

pub fn reason(&self) -> EndReason

Return the provided EndReason for this End cell.

Trait Implementations

impl Body for End

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 End

fn clone(&self) -> End

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for End

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

Formats the value using the given formatter.

impl From<End> for AnyRelayMsg

fn from(m: End) -> AnyRelayMsg

Converts to this type from the input type.

impl HasMemoryCostStructural for End

fn indirect_memory_cost(&self, et: EnabledToken) -> usize

Memory cost of data stored out-of-line

impl RelayMsg for End

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 End

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.