Struct tor_proto::channel::params::ChannelPaddingInstructionsUpdatesBuilder

pub struct ChannelPaddingInstructionsUpdatesBuilder<'c> { /* private fields */ }

Builder for a channels padding instructions update

Obtain this from ChannelPaddingInstructions::update, call zero or more setter methods, call finish, and then send the resulting message.

Panics

Panics if dropped. Instead, call finish.

Implementations

impl<'c> ChannelPaddingInstructionsUpdatesBuilder<'c>

pub fn padding_enable(self, new_value: bool) -> Self

Whether to send padding

(Adds this setting to the update, if it has changed.)

pub fn padding_parameters(self, new_value: Parameters) -> Self

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.

(Adds this setting to the update, if it has changed.)

pub fn padding_negotiate(self, new_value: PaddingNegotiate) -> Self

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

(Adds this setting to the update, if it has changed.)

impl<'c> ChannelPaddingInstructionsUpdatesBuilder<'c>

pub fn finish(self) -> Option<ChannelPaddingInstructionsUpdates>

Finalise the update

If nothing actually changed, returns None. (Tracking this, and returning None, allows us to avoid bothering every channel with a null update.)

If Some is returned, the update must be implemented, since the underlying tracking ChannelPaddingInstructions has already been updated.

Trait Implementations

impl<'c> Drop for ChannelPaddingInstructionsUpdatesBuilder<'c>

fn drop(&mut self)

Executes the destructor for this type.