Struct SendPadding 

pub(crate) struct SendPadding {
    machine: MachineId,
    pub(crate) hop: HopNum,
    pub(crate) replace: Replace,
    pub(crate) bypass: Bypass,
}

An indication that we should send a padding cell.

Don’t drop this: instead, once the cell is queued, pass this SendPadding object to the relevant PaddingController to report that the particular piece of padding has been queued.

Fields

machine: MachineId

The machine within a framework that told us to send the padding.

We store this so we can tell the framework which machine’s padding we sent.

hop: HopNum

The hop to which we need to send the padding.

replace: Replace

Whether this padding can be replaced by regular data.

bypass: Bypass

Whether this padding cell should bypass any current blocking.

Implementations

impl SendPadding

fn into_sent_event(self) -> TriggerEvent

Convert this SendPadding into a TriggerEvent for Maybenot, to indicate that the padding was sent.

pub(crate) fn may_replace_with_data(&self) -> Replace

If true, we are allowed to replace this padding cell with a normal non-padding cell.

(If we do, we should call PaddingController::queued_data_as_padding)

pub(crate) fn may_bypass_block(&self) -> Bypass

Return whether this padding cell is allowed to bypass any current blocking.

Trait Implementations

impl Clone for SendPadding

fn clone(&self) -> SendPadding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SendPadding

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

Formats the value using the given formatter.

impl Copy for SendPadding