Struct Datagram 

pub struct Datagram {
    body: Vec<u8>,
}

A Datagram message represents data sent along a UDP stream.

Upon receiving a Datagram message for a live stream, the client or exit sends that data onto the associated UDP connection.

These messages hold between 1 and Datagram::MAXLEN bytes of data each.

Fields

body: Vec<u8>

Contents of the cell, to be sent on a specific stream

Implementations

impl Datagram

pub const MAXLEN: usize

NOTE: Proposal 340, fragmented relay message, might change this value reality. The longest allowable body length for a single data cell.

pub fn new(inp: &[u8]) -> Result<Self>

Construct a new data cell.

Returns an error if inp is longer than Datagram::MAXLEN bytes.

fn new_unchecked(body: Vec<u8>) -> Self

Construct a new cell from a provided vector of bytes.

The vector must have fewer than Datagram::MAXLEN bytes.

Trait Implementations

impl AsRef<[u8]> for Datagram

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Body for Datagram

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 Datagram

fn clone(&self) -> Datagram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Datagram

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

Formats the value using the given formatter.

impl From<Datagram> for AnyRelayMsg

Available on crate feature experimental-udp only.

fn from(m: Datagram) -> AnyRelayMsg

Converts to this type from the input type.

impl From<Datagram> for Vec<u8>

fn from(data: Datagram) -> Vec<u8>

Converts to this type from the input type.

impl HasMemoryCostStructural for Datagram

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

Memory cost of data stored out-of-line

impl RelayMsg for Datagram

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 Datagram

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.