Skip to main content

RouteFlags

Struct RouteFlags 

Source
pub struct RouteFlags(/* private fields */);
Expand description

Route flags (bitflags — multiple flags can be set simultaneously)

Implementations§

Source§

impl RouteFlags

Source

pub const NONE: Self

No special flags

Source

pub const CONTROL: Self

Control packet (pingwave, capability update)

Source

pub const REQUIRES_ACK: Self

Requires acknowledgment

Source

pub const PRIORITY: Self

Priority packet (skip fairness queue)

Source

pub const END_OF_STREAM: Self

Last packet in stream

Source

pub fn from_u8(v: u8) -> Self

Parse flags from u8.

The & 0x0F mask drops the high nibble. Today the defined flags fit in the low nibble (CONTROL, REQUIRES_ACK, PRIORITY, END_OF_STREAM), so 16 distinct wire bytes alias to the same RouteFlags. The high nibble is reserved: any future flag added there will be silently stripped by old peers running this codepath. When a new flag is introduced:

  1. Allocate it in the low nibble if any bit is still free, OR
  2. Widen this mask in the same release that defines the new flag, in lock-step across every peer that decodes routing headers (Rust + cross-language bindings). A skew where one peer reads the bit and another masks it off silently diverges on routing semantics.
Source

pub fn as_u8(self) -> u8

Convert to u8

Source

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

Check if a flag is set

Source

pub fn is_control(self) -> bool

Check if this is a control packet

Source

pub fn is_priority(self) -> bool

Check if this is a priority packet

Trait Implementations§

Source§

impl Clone for RouteFlags

Source§

fn clone(&self) -> RouteFlags

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 Copy for RouteFlags

Source§

impl Debug for RouteFlags

Source§

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

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

impl Default for RouteFlags

Source§

fn default() -> RouteFlags

Returns the “default value” for a type. Read more
Source§

impl Eq for RouteFlags

Source§

impl PartialEq for RouteFlags

Source§

fn eq(&self, other: &RouteFlags) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RouteFlags

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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, 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