Skip to main content

SubprotocolDescriptor

Struct SubprotocolDescriptor 

Source
pub struct SubprotocolDescriptor {
    pub id: u16,
    pub name: String,
    pub version: SubprotocolVersion,
    pub min_compatible: SubprotocolVersion,
    pub handler_present: bool,
}
Expand description

Metadata describing a registered subprotocol.

Fields§

§id: u16

Unique protocol ID (from Net header subprotocol_id field).

§name: String

Human-readable name (e.g., “causal”, “migration”, “vendor-x-inference”).

§version: SubprotocolVersion

Version of this handler.

§min_compatible: SubprotocolVersion

Minimum compatible version accepted from peers.

§handler_present: bool

Whether this node can process packets for this subprotocol (false = opaque forwarding only, no local handler).

Implementations§

Source§

impl SubprotocolDescriptor

Source

pub fn new( id: u16, name: impl Into<String>, version: SubprotocolVersion, ) -> Self

Create a new descriptor.

Source

pub fn with_min_compatible(self, min: SubprotocolVersion) -> Self

Set the minimum compatible version.

Enforces the wire-format invariant min_compatible <= version. Allowing min_compatible > version would break is_compatible_with’s contract — every honest peer computes local.version.satisfies(other.min_compatible), which silently fails for any version of local once other.min_compatible > other.version. On the wire-format side that enables a phantom-incompatibility DoS where a peer advertises min_compatible=255.255 against version=1.0 and unilaterally evicts the subprotocol from negotiation. The constructor (new) initializes min_compatible = version so the invariant holds by default; this setter clamps min to self.version if a caller passes a higher value.

Source

pub fn forwarding_only(self) -> Self

Mark as forwarding-only (no local handler).

Source

pub fn is_compatible_with(&self, other: &Self) -> bool

Check if two descriptors are version-compatible.

Both sides must satisfy the other’s minimum requirement.

Source

pub fn capability_tag(&self) -> String

Capability tag for this subprotocol (e.g., “subprotocol:0x0400”).

Trait Implementations§

Source§

impl Clone for SubprotocolDescriptor

Source§

fn clone(&self) -> SubprotocolDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SubprotocolDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SubprotocolDescriptor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more