ChannelRegistry

Struct ChannelRegistry 

Source
pub struct ChannelRegistry { /* private fields */ }
Expand description

The channels a session can hold a conversation in, and the keys to reach them.

Channel membership already lives in the MAC, which resolves an inbound frame to a key by authenticating it. This is the chat layer’s own view: it maps between the tag a conversation is keyed by and the key a send needs, in both directions.

Implementations§

Source§

impl ChannelRegistry

Source

pub fn register( &mut self, tag: ChannelTag, key: ChannelKey, max_flood_hops: Option<u8>, )

Hold tag’s channel, reached with key. Registering a held channel again replaces its key and ceiling.

Source

pub fn remove(&mut self, tag: &ChannelTag)

Source

pub fn key(&self, tag: &ChannelTag) -> Option<ChannelKey>

Source

pub fn tag_for(&self, key: &ChannelKey) -> Option<ChannelTag>

The tag of the held channel key reaches.

A received frame names its channel by the key that authenticated it, which is the truth about which channel it belongs to: distinct keys may share the two-byte identifier the frame carried.

Source

pub fn max_flood_hops(&self, tag: &ChannelTag) -> Option<u8>

The flood-hop ceiling registered for a channel, if the user set one. None both for a channel left at the default and for one not registered at all.

Source

pub fn contains(&self, tag: &ChannelTag) -> bool

Source

pub fn tags(&self) -> impl Iterator<Item = ChannelTag> + '_

Trait Implementations§

Source§

impl Clone for ChannelRegistry

Source§

fn clone(&self) -> ChannelRegistry

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ChannelRegistry

Source§

fn default() -> ChannelRegistry

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

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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<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, 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.

Source§

impl<T> Same for T

Source§

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.