Struct RelayMsgOuter

pub struct RelayMsgOuter<M> {
    streamid: Option<StreamId>,
    msg: M,
}

A decoded and parsed relay message, along with an optional Stream ID.

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

NOTE: This name is a placeholder; we intend to replace it once we have standardized our vocabulary in this area.

Fields

streamid: Option<StreamId>

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

msg: M

The relay message for this cell.

Implementations

impl<M: RelayMsg> RelayMsgOuter<M>

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

Construct a new relay cell.

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

Consume this cell and return its components.

pub fn cmd(&self) -> RelayCmd

Return the command for this cell.

pub fn stream_id(&self) -> Option<StreamId>

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

pub fn msg(&self) -> &M

Return the underlying message for this cell.

pub fn into_msg(self) -> M

Consume this cell and return the underlying message.

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

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

fn encode_to_cell_v0(self) -> EncodeResult<(BoxedCellBody, usize)>

Consume a relay cell and return its contents, encoded for use in a RELAY or RELAY_EARLY cell.

fn encode_to_cell_v1(self) -> EncodeResult<(BoxedCellBody, usize)>

Consume a relay cell and return its contents, encoded for use in a RELAY or RELAY_EARLY cell.

pub fn decode_singleton( version: RelayCellFormat, body: BoxedCellBody, ) -> Result<Self>

Parse a RELAY or RELAY_EARLY cell body into a RelayMsgOuter. Requires that the cryptographic checks on the message have already been performed

Fails if the cell doesn’t contain exactly one message.

Non-test code should generally use RelayCellDecoder instead.

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

Parse a RelayCellFormat::V0 RELAY or RELAY_EARLY cell body into a RelayMsgOuter from a reader.

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

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

Parse a RelayCellFormat::V1 RELAY or RELAY_EARLY cell body into a RelayMsgOuter from a reader.

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

Trait Implementations

impl<M: Debug> Debug for RelayMsgOuter<M>

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

Formats the value using the given formatter.