Skip to main content

ProtocolFlags

karyon_p2p::protocol

Struct ProtocolFlags

pub struct ProtocolFlags(u32);

Expand description

Bit flags describing how a protocol takes part in handshake and discovery. Combine with |. empty() means the protocol is negotiated but neither required nor advertised.

Tuple Fields§

§0: u32

Implementations§

impl ProtocolFlags

pub const REQUIRED: Self

Peers must speak this protocol. Handshake fails if absent and discovery filters out peers that do not advertise it.

pub const PREFERRED: Self

Advertised so discovery prefers peers that also have it, but peers without it are still accepted. The default.

pub const USER: Self

First bit free for user-defined meaning. Bits below are reserved by karyon. Kademlia advertises items carrying only user bits without letting them affect peer selection; custom Discovery impls may give them any meaning.

pub const fn empty() -> Self

No flags set.

pub const fn bits(self) -> u32

Raw bit pattern.

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

True if every bit in other is set in self.

Trait Implementations§

impl BitOr for ProtocolFlags

type Output = ProtocolFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation. Read more

impl BitOrAssign for ProtocolFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more

impl Clone for ProtocolFlags

fn clone(&self) -> ProtocolFlags

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

impl Copy for ProtocolFlags

impl Debug for ProtocolFlags

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

Formats the value using the given formatter. Read more

impl Eq for ProtocolFlags

impl From<u32> for ProtocolFlags

fn from(bits: u32) -> Self

Converts to this type from the input type.

impl PartialEq for ProtocolFlags

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

impl StructuralPartialEq for ProtocolFlags

Auto Trait Implementations§

impl Freeze for ProtocolFlags

impl RefUnwindSafe for ProtocolFlags

impl Send for ProtocolFlags

impl Sync for ProtocolFlags

impl Unpin for ProtocolFlags

impl UnsafeUnpin for ProtocolFlags

impl UnwindSafe for ProtocolFlags

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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