Struct ChannelPaddingInstructionsUpdates

pub struct ChannelPaddingInstructionsUpdates {
    pub(crate) padding_enable: Option<bool>,
    pub(crate) padding_parameters: Option<Parameters>,
    pub(crate) padding_negotiate: Option<PaddingNegotiate>,
}

New instructions to the reactor

Can contain updates to each of the fields in ChannelPaddingInstructions. Constructed via ChannelPaddingInstructionsUpdatesBuilder, which is obtained from ChannelPaddingInstructions::start_update.

Sent to all channel implementations, when they ought to change their behaviour.

Fields

padding_enable: Option<bool>

New value, if it has changed.

Having this contain Option allows the sender of an update to promise that the value hasn’t changed, and thereby allows the channel implementation to avoid touching state that it doesn’t need to (eg, timers).

padding_parameters: Option<Parameters>

New value, if it has changed.

Having this contain Option allows the sender of an update to promise that the value hasn’t changed, and thereby allows the channel implementation to avoid touching state that it doesn’t need to (eg, timers).

padding_negotiate: Option<PaddingNegotiate>

New value, if it has changed.

Having this contain Option allows the sender of an update to promise that the value hasn’t changed, and thereby allows the channel implementation to avoid touching state that it doesn’t need to (eg, timers).

Implementations

impl ChannelPaddingInstructionsUpdates

pub fn combine(&mut self, more: &Self)

Combines more into self

Values from more override ones in self.

pub fn padding_enable(&self) -> Option<&bool>

Available on crate feature testing only.

Whether to send padding

Accessor. For testing the logic which generates channel padding control instructions.

pub fn padding_parameters(&self) -> Option<&Parameters>

Available on crate feature testing only.

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.

Accessor. For testing the logic which generates channel padding control instructions.

pub fn padding_negotiate(&self) -> Option<&PaddingNegotiate>

Available on crate feature testing only.

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.)

Accessor. For testing the logic which generates channel padding control instructions.

Trait Implementations

impl Clone for ChannelPaddingInstructionsUpdates

fn clone(&self) -> ChannelPaddingInstructionsUpdates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelPaddingInstructionsUpdates

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

Formats the value using the given formatter.

impl Default for ChannelPaddingInstructionsUpdates

fn default() -> ChannelPaddingInstructionsUpdates

Returns the “default value” for a type.

impl PartialEq for ChannelPaddingInstructionsUpdates

fn eq(&self, other: &ChannelPaddingInstructionsUpdates) -> 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 ChannelPaddingInstructionsUpdates

impl StructuralPartialEq for ChannelPaddingInstructionsUpdates