Struct Relay

pub struct Relay {
    body: BoxedCellBody,
}

A Relay cell - that is, one transmitted over a circuit.

Once a circuit has been established, relay cells can be sent over it. Clients can send relay cells to any relay on the circuit. Any relay on the circuit can send relay cells to the client, either directly (if it is the first hop), or indirectly through the intermediate hops.

A different protocol is defined over the relay cells; it is implemented in the crate::relaycell module.

Fields

body: BoxedCellBody

The contents of the relay cell as encoded for transfer.

TODO(nickm): It’s nice that this is boxed, since we don’t want to copy cell data all over the place. But unfortunately, there are some other places where we don’t Box things that we should, and more copies than necessary happen. We should refactor our data handling until we’re mostly moving around pointers rather than copying data; see ticket #7.

Implementations

impl Relay

pub fn new<P>(body: P) -> Self

where P: AsRef<[u8]>,

Construct a Relay message from a slice containing its contents.

pub fn from_raw(body: RawCellBody) -> Self

Construct a Relay message from its body.

pub fn into_relay_body(self) -> BoxedCellBody

Consume this Relay message and return a BoxedCellBody for encryption/decryption.

pub fn into_early(self) -> AnyChanMsg

Wrap this Relay message into a RelayMsg as a RELAY_EARLY cell.

Trait Implementations

impl Body for Relay

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

Consume this message and encode its body onto w.

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

Decode a channel cell body from a provided reader.

impl ChanMsg for Relay

fn cmd(&self) -> ChanCmd

Return the ChanCmd for this message.

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

Write the body of this message (not including length or command).

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

Decode this message from a given reader, according to a specified command value. The reader must be truncated to the exact length of the body.

impl Clone for Relay

fn clone(&self) -> Relay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Relay

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

Formats the value using the given formatter.

impl From<Box<[u8; 509]>> for Relay

fn from(value: BoxedCellBody) -> Self

Converts to this type from the input type.

impl From<Relay> for AnyChanMsg

fn from(m: Relay) -> AnyChanMsg

Converts to this type from the input type.

impl From<Relay> for RelayEarly

fn from(value: Relay) -> Self

Converts to this type from the input type.

impl From<RelayEarly> for Relay

fn from(value: RelayEarly) -> Self

Converts to this type from the input type.

impl HasMemoryCostStructural for Relay

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

Memory cost of data stored out-of-line

impl Readable for Relay

fn take_from(b: &mut Reader<'_>) -> Result<Self>

Try to extract an object of this type from a Reader.