Enum tor_cell::relaycell::extend::NtorV3Extension

#[non_exhaustive]
pub enum NtorV3Extension {
    RequestCongestionControl,
    AckCongestionControl {
        sendme_inc: u8,
    },
    Unrecognized {
        field_type: NtorV3ExtensionType,
        data: Vec<u8>,
    },
}

A piece of extension data, to be encoded as the message in an ntor v3 handshake.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RequestCongestionControl

Request congestion control be enabled for this circuit (client → exit node).

(EXT_FIELD_TYPE = 01)

AckCongestionControl

Acknowledge a congestion control request (exit node → client).

(EXT_FIELD_TYPE = 02)

Fields

sendme_inc: u8

The exit’s current view of the cc_sendme_inc consensus parameter.

Unrecognized

An unknown piece of extension data.

Fields

field_type: NtorV3ExtensionType

The extension type (EXT_FIELD_TYPE).

data: Vec<u8>

The raw bytes of unrecognized extension data.

Implementations

impl NtorV3Extension

pub fn write_many_onto<W: Writer>( exts: &[NtorV3Extension], out: &mut W, ) -> EncodeResult<()>

Encode a set of extensions into a “message” for an ntor v3 handshake.

pub fn decode(message: &[u8]) -> Result<Vec<Self>>

Decode a slice of bytes representing the “message” of an ntor v3 handshake into a set of extensions.

Trait Implementations

impl Clone for NtorV3Extension

fn clone(&self) -> NtorV3Extension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NtorV3Extension

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

Formats the value using the given formatter.

impl PartialEq for NtorV3Extension

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

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

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

impl Writeable for NtorV3Extension

fn write_onto<W: Writer + ?Sized>(&self, out: &mut W) -> EncodeResult<()>

Encode this object into the writer b.

impl Eq for NtorV3Extension

impl StructuralPartialEq for NtorV3Extension