Struct CapabilitiesNegotiator 

pub struct CapabilitiesNegotiator { /* private fields */ }

Per-member set of advertised capability tokens.

Implementations

impl CapabilitiesNegotiator

pub fn new() -> CapabilitiesNegotiator

Empty negotiator (no member has advertised anything yet).

pub fn advertise<I, S>(&mut self, member: u32, capabilities: I)

where I: IntoIterator<Item = S>, S: Into<String>,

Records an advertisement. Replaces any prior advertisement from the same member.

pub fn forget(&mut self, member: u32)

Removes a member’s advertisement (e.g. after LEAVE).

pub fn capabilities_of(&self, member: u32) -> Option<&BTreeSet<String>>

Returns the current advertisement for member.

pub fn group_supports(&self, cap: &str) -> bool

true if every advertised member supports cap.

pub fn intersection(&self) -> BTreeSet<String>

Returns the intersection — capabilities that every member advertises, i.e. the safe-to-use set.

pub fn union(&self) -> BTreeSet<String>

Returns the union — every capability advertised by any member.

pub fn missing(&self, cap: &str) -> Vec<u32>

Returns the members that did not advertise cap.

pub fn len(&self) -> usize

Number of members that advertised something.

pub fn is_empty(&self) -> bool

Empty?

pub fn declare_class(&mut self, member: u32, class: ConformanceClass)

Declares the conformance class for member by inserting the appropriate well-known tokens (gbp-interop-profile §2).

Each higher class implies the lower ones, so Class C inserts tokens for A, B and C. Tokens are merged with any existing capabilities for that member.

pub fn group_class(&self) -> Option<ConformanceClass>

Returns the highest ConformanceClass that every member in the negotiation supports, or None if no member has advertised any class.

pub fn reset_for_epoch(&mut self)

Clears all advertisements. Call on epoch advance for symmetry with [GapClient::sync_epoch], [GtpClient::sync_epoch] and [GspClient::sync_epoch].

Trait Implementations

impl Default for CapabilitiesNegotiator

fn default() -> CapabilitiesNegotiator

Returns the “default value” for a type.