Struct tor_cell::relaycell::msg::Begin

pub struct Begin { /* private fields */ }

A Begin message creates a new data stream.

Upon receiving a Begin message, relays should try to open a new stream for the client, if their exit policy permits, and associate it with a new TCP connection to the target address.

If the exit decides to reject the Begin message, or if the TCP connection fails, the exit should send an End message.

Clients should reject these messages.

Implementations

impl Begin

pub fn new<F>(addr: &str, port: u16, flags: F) -> Result<Self>

where F: Into<BeginFlags>,

Construct a new Begin cell

pub fn addr(&self) -> &[u8]

Return the address requested in this message.

pub fn port(&self) -> u16

Return the port requested by this message.

pub fn flags(&self) -> BeginFlags

Return the set of flags provided in this message.

Trait Implementations

impl Body for Begin

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 Begin

fn clone(&self) -> Begin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Begin

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 RelayMsg for Begin

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 Begin

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.