Struct CapabilitySet 

pub struct CapabilitySet { /* private fields */ }

A set of advertised capabilities.

A u128 bitset, so contains is a mask and a test rather than a search. This matters because resolve asks roughly thirty questions of two sets, and a session asks FeatureProfile::allows on every message.

Implementations

impl CapabilitySet

pub const fn empty() -> Self

The empty set, which is what a peer that advertises nothing gets.

pub fn all() -> Self

Every capability, on both sides. A superset of anything real, and mostly useful in tests and in the “what could this peer possibly do” query.

pub fn all_for(version: ProtocolVersion) -> Self

Every capability version defines, on both sides.

The “all capabilities on” case for a golden test, scoped to one revision so the result is something a peer could actually have sent.

pub fn with(self, capability: Capability) -> Self

Adds a capability, returning the new set.

By value rather than &mut self so that building a set in an expression does not need a mutable binding, which is what every caller ends up writing.

pub fn insert(&mut self, capability: Capability)

Adds a capability in place.

pub fn contains(self, capability: Capability) -> bool

Whether the capability is in the set.

pub const fn is_empty(self) -> bool

Whether the set holds nothing.

pub const fn len(self) -> u32

How many capabilities the set holds.

pub fn iter(self) -> impl Iterator<Item = Capability>

The capabilities in the set, in declaration order.

pub fn restricted_to(self, version: ProtocolVersion) -> Self

Drops every capability version does not define.

A peer cannot advertise a flag its own revision’s schema has no field for, and a flag that survives the round trip from a newer peer into an older profile is exactly the “confident wrong” the crate exists to avoid. An unknown revision therefore reduces the set to empty.

Trait Implementations

impl Clone for CapabilitySet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CapabilitySet

impl Debug for CapabilitySet

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

Formats the value using the given formatter.

impl Default for CapabilitySet

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CapabilitySet

impl Hash for CapabilitySet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CapabilitySet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CapabilitySet