Struct Padding

#[non_exhaustive]
pub struct Padding {}

A Padding message is a fixed-length message on a channel that is ignored.

Padding message can be used to disguise the true amount of data on a channel, or as a “keep-alive”.

The correct response to a padding cell is to drop it and do nothing.

Implementations

impl Padding

pub fn new() -> Self

Create a new fixed-length padding cell

Trait Implementations

impl Body for Padding

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 Padding

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 Padding

fn clone(&self) -> Padding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Padding

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

Formats the value using the given formatter.

impl Default for Padding

fn default() -> Padding

Returns the “default value” for a type.

impl From<Padding> for AnyChanMsg

fn from(m: Padding) -> AnyChanMsg

Converts to this type from the input type.

impl From<Padding> for AnyChanCell

fn from(body: Padding) -> AnyChanCell

Converts to this type from the input type.

impl HasMemoryCostStructural for Padding

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

Memory cost of data stored out-of-line

impl Readable for Padding

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

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