Struct ChannelPaddingInstructions

pub struct ChannelPaddingInstructions {
    pub(crate) padding_enable: bool,
    pub(crate) padding_parameters: Parameters,
    pub(crate) padding_negotiate: PaddingNegotiate,
}

Initial, and, overall, padding instructions for channels

This is used both to generate the initial instructions, and to handle updates: when used for handling updates, it contains the last instructions that has been implemented.

Central code managing all channels will contain a ChannelPaddingInstructions, and use ChannelPaddingInstructionsUpdatesBuilder to both update those Instructions and generate ChannelPaddingInstructionsUpdates messages representing the changes.

The channel frontend (methods on Channel) processes ChannelPaddingInstructionsUpdates from the channel manager, possibly into channel-specific updates.

Default is a placeholder to use pending availability of a netdir etc.

Fields

padding_enable: bool

Whether to send padding

padding_parameters: Parameters

Padding timing parameters

This is in abeyance if send_padding is false; we still pass it because the usual case is that padding is enabled/disabled rather than the parameters changing, so the padding timer always keeps parameters, even when disabled.

padding_negotiate: PaddingNegotiate

Channel padding negotiation cell

In ChannelPaddingInstructions, and when set via Builder, this is the PADDING_NEGOTIATE cell which should be used when we want to instruct our peer (the guard) to do padding like we have concluded we want.

(An initial PaddingNegotiate::start_default() is elided in Channel::engage_padding_activities since that is what the peer would do anyway.)

Implementations

impl ChannelPaddingInstructions

pub fn initial_update(&self) -> Option<ChannelPaddingInstructionsUpdates>

Create an update message which sets settings in self which are not equal to the initial behaviour of the reactor.

Used during channel startup.

impl ChannelPaddingInstructions

pub fn start_update(&mut self) -> ChannelPaddingInstructionsUpdatesBuilder<'_>

Start building an update to channel padding instructions

The builder must not be dropped, once created; instead, finish must be called. So prepare your new values first, perhaps fallibly, and only then create and use the builder and send the update, infallibly.

(This is because the builder uses self: ChannelPaddingInstructions to track which values have changed, and the values in self are updated immediately by the field update methods.)

Panics

ChannelPaddingInstructionsUpdatesBuilder panics if it is dropped.

Trait Implementations

impl Clone for ChannelPaddingInstructions

fn clone(&self) -> ChannelPaddingInstructions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelPaddingInstructions

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

Formats the value using the given formatter.

impl Default for ChannelPaddingInstructions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ChannelPaddingInstructions

fn eq(&self, other: &ChannelPaddingInstructions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ChannelPaddingInstructions

impl StructuralPartialEq for ChannelPaddingInstructions