Struct IdSet 

pub struct IdSet { /* private fields */ }

Available on crate feature api only.

A set of message ids, such as the ids an Id type knows, see Id::IDS.

A set is built at compile time out of the ids of one define! list and the sets of the lists it includes, so it is cheap to construct but looking an id up in it is a linear scan. It is used to check, at compile time, that two lists which share a connection never use the same id.

Examples

Checking in a test (or a const item) that two lists which are never included into one another, but are carried on the same connection, do not share an id:

use musli::{Decode, Encode};
use musli_web::api::Id;

mod app {
    #[derive(Encode, Decode)]
    pub struct HelloRequest;

    api::define! {
        pub type Hello;

        impl Endpoint for Hello {
            impl Request for HelloRequest;
            type Response<'de> = ();
        }
    }
}

mod lib {
    #[derive(Encode, Decode)]
    pub struct LoginRequest;

    api::define! {
        #[musli(id = 32000)]
        pub type Login;

        impl Endpoint for Login {
            impl Request for LoginRequest;
            type Response<'de> = ();
        }
    }
}

const _: () = assert!(app::Request::IDS.is_disjoint(&lib::Request::IDS));
assert_eq!(app::Request::IDS.first_shared(&lib::Request::IDS), None);

Implementations

impl IdSet

pub const EMPTY: Self

The empty set.

pub const fn contains(&self, id: MessageId) -> bool

Test if the set contains id.

pub const fn is_disjoint(&self, other: &IdSet) -> bool

Test if the set has no id in common with other.

pub const fn first_shared(&self, other: &IdSet) -> Option<MessageId>

Find the first id in this set which is also in other, if any.

pub const fn is_empty(&self) -> bool

Test if the set is empty.

Trait Implementations

impl Clone for IdSet

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 IdSet

impl Debug for IdSet

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

Formats the value using the given formatter.