Enum CircRequestExt

#[non_exhaustive]
pub enum CircRequestExt {
    CcRequest(CcRequest),
    ProofOfWork(ProofOfWork),
    SubprotocolRequest(SubprotocolRequest),
    Unrecognized(UnrecognizedExt<CircRequestExtType>),
}

An extension to be sent along with a circuit extension request (CREATE2, EXTEND2, or INTRODUCE.)

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.

CcRequest(CcRequest)

Request to enable congestion control.

ProofOfWork(ProofOfWork)

Available on crate feature hs only.

HS-only: Provide a proof-of-work solution.

SubprotocolRequest(SubprotocolRequest)

Request to enable one or more subprotocol capabilities.

Unrecognized(UnrecognizedExt<CircRequestExtType>)

An extension of a type we do not recognize, or which we have not encoded.

Implementations

impl CircRequestExt

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

Encode a set of extensions into a “message” for a circuit handshake.

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

Decode a slice of bytes representing the “message” of a circuit handshake into a set of extensions.

Trait Implementations

impl Clone for CircRequestExt

fn clone(&self) -> CircRequestExt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircRequestExt

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

Formats the value using the given formatter.

impl From<CcRequest> for CircRequestExt

fn from(val: CcRequest) -> CircRequestExt

Converts to this type from the input type.

impl From<ProofOfWork> for CircRequestExt

Available on crate feature hs only.

fn from(val: ProofOfWork) -> CircRequestExt

Converts to this type from the input type.

impl From<SubprotocolRequest> for CircRequestExt

fn from(val: SubprotocolRequest) -> CircRequestExt

Converts to this type from the input type.

impl From<UnrecognizedExt<CircRequestExtType>> for CircRequestExt

fn from(val: UnrecognizedExt<CircRequestExtType>) -> CircRequestExt

Converts to this type from the input type.

impl PartialEq for CircRequestExt

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

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

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

impl Writeable for CircRequestExt

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

Encode this object into the writer b.

impl StructuralPartialEq for CircRequestExt