pub struct RelayCell<M> { /* private fields */ }
Expand description

A decoded and parsed relay cell.

Each relay cell represents a message that can be sent along a circuit, along with the ID for an associated stream that the message is meant for.

Implementations§

source§

impl<M: RelayMsg> RelayCell<M>

source

pub fn new(streamid: StreamId, msg: M) -> Self

Construct a new relay cell.

source

pub fn into_streamid_and_msg(self) -> (StreamId, M)

Consume this cell and return its components.

source

pub fn cmd(&self) -> RelayCmd

Return the command for this cell.

source

pub fn stream_id(&self) -> StreamId

Return the stream ID for the stream that this cell corresponds to.

source

pub fn msg(&self) -> &M

Return the underlying message for this cell.

source

pub fn into_msg(self) -> M

Consume this cell and return the underlying message.

source

pub fn encode<R: Rng + CryptoRng>(self, rng: &mut R) -> Result<BoxedCellBody>

Consume this relay message and encode it as a 509-byte padded cell body.

source

pub fn decode(body: BoxedCellBody) -> Result<Self>

Parse a RELAY or RELAY_EARLY cell body into a RelayCell.

Requires that the cryptographic checks on the message have already been performed

source

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

Parse a RELAY or RELAY_EARLY cell body into a RelayCell from a reader.

Requires that the cryptographic checks on the message have already been performed

Trait Implementations§

source§

impl<M: Debug> Debug for RelayCell<M>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<M> RefUnwindSafe for RelayCell<M>where M: RefUnwindSafe,

§

impl<M> Send for RelayCell<M>where M: Send,

§

impl<M> Sync for RelayCell<M>where M: Sync,

§

impl<M> Unpin for RelayCell<M>where M: Unpin,

§

impl<M> UnwindSafe for RelayCell<M>where M: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more