Struct PaddingNegotiate

pub struct PaddingNegotiate {
    command: PaddingNegotiateCmd,
    ito_low_ms: u16,
    ito_high_ms: u16,
}

A PaddingNegotiate message is used to negotiate channel padding.

Sent by a client to its guard node, to instruct the relay to enable/disable channel padding. (Not relevant for channels used only for directory lookups, nor inter-relay channels.) See padding-spec.txt, section 2.2.

This message is constructed in the channel manager and transmitted by the reactor.

The Default impl is the same as start_default()

Fields

command: PaddingNegotiateCmd

Whether to start or stop padding

ito_low_ms: u16

Suggested lower-bound value for inter-packet timeout in msec.

ito_high_ms: u16

Suggested upper-bound value for inter-packet timeout in msec.

Implementations

impl PaddingNegotiate

pub fn start_default() -> Self

Create a new PADDING_NEGOTIATE START message requesting consensus timing parameters.

This message restores the state to the one which exists at channel startup.

pub fn start( ito_low: IntegerMilliseconds<u16>, ito_high: IntegerMilliseconds<u16>, ) -> Self

Create a new PADDING_NEGOTIATE START message.

pub fn stop() -> Self

Create a new PADDING_NEGOTIATE STOP message.

pub fn from_raw( command: PaddingNegotiateCmd, ito_low_ms: u16, ito_high_ms: u16, ) -> Self

Available on crate feature testing only.

Construct from the three fields: command, low_ms, high_ms, as a tuple

For testing only

Trait Implementations

impl Body for PaddingNegotiate

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 PaddingNegotiate

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 PaddingNegotiate

fn clone(&self) -> PaddingNegotiate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaddingNegotiate

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

Formats the value using the given formatter.

impl Default for PaddingNegotiate

fn default() -> Self

Returns the “default value” for a type.

impl From<PaddingNegotiate> for AnyChanMsg

fn from(m: PaddingNegotiate) -> AnyChanMsg

Converts to this type from the input type.

impl From<PaddingNegotiate> for AnyChanCell

fn from(body: PaddingNegotiate) -> AnyChanCell

Converts to this type from the input type.

impl HasMemoryCostStructural for PaddingNegotiate

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

Memory cost of data stored out-of-line

impl PartialEq for PaddingNegotiate

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

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

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

impl Eq for PaddingNegotiate

impl StructuralPartialEq for PaddingNegotiate