Struct CapabilitySet 

pub struct CapabilitySet(/* private fields */);

A set of capabilities agreed between two peers.

Thin wrapper around BTreeSet<Capability> whose only job is to name the CapabilitySet::intersect operation that both clients and servers perform on handshake: each side advertises the capabilities it supports, and the intersection is the set both agree to use for the rest of the session.

This type stays pure-data (no network, no HTTP) so both mnem http and mnem-transport::client can consume it.

Implementations

impl CapabilitySet

pub fn new() -> Self

Empty capability set.

pub fn with_caps<I: IntoIterator<Item = Capability>>(caps: I) -> Self

Build from any capability iterator. Duplicates are collapsed.

pub fn all_known() -> Self

Every capability this build knows about. Equivalent to with_caps(Capability::all().iter().copied()) but allocates once rather than walking a slice.

pub fn parse(s: &str) -> Self

Parse from the comma-separated wire form; unknown entries are dropped (forward-compat, same rule as parse_capabilities).

pub fn serialize(&self) -> String

Serialize to the comma-separated wire form, ascending order.

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

Capability intersection: the set of capabilities both peers advertised. This is the agreed-upon feature set for the remainder of the session.

intersect(A, B) = { c | c in A and c in B }

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

True if the given capability is in this set.

pub fn len(&self) -> usize

Number of capabilities in the set.

pub fn is_empty(&self) -> bool

True iff the set has no capabilities.

pub const fn as_set(&self) -> &BTreeSet<Capability>

Borrow the underlying sorted set.

Trait Implementations

impl Clone for CapabilitySet

fn clone(&self) -> CapabilitySet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilitySet

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

Formats the value using the given formatter.

impl Default for CapabilitySet

fn default() -> CapabilitySet

Returns the “default value” for a type.

impl From<BTreeSet<Capability>> for CapabilitySet

fn from(s: BTreeSet<Capability>) -> Self

Converts to this type from the input type.

impl PartialEq for CapabilitySet

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

impl StructuralPartialEq for CapabilitySet