Struct ChannelId 

pub struct ChannelId { /* private fields */ }

Available on crate feature api only.

A unique and opaque identifier for a channel over the websocket.

Implementations

impl ChannelId

pub const NONE: Self

The channel id used for an invalid channel.

pub const fn from_u16(repr: u16) -> Self

Construct a new channel id from a raw u16 representation.

Note that this does not guarantee that the internal representation of a channel identifier is exactly a u16, only that at least u16 unique identifiers can be constructed.

Using 0 is equivalent to ChannelId::NONE. When implementing a custom ChannelAllocator the allocator must avoid constructor identifiers with this value since it is equivalent to no channel.

Examples

use musli_web::api::ChannelId;
let id = ChannelId::from_u16(0);
assert_eq!(id, ChannelId::NONE);

Trait Implementations

impl Clone for ChannelId

fn clone(&self) -> ChannelId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelId

impl Debug for ChannelId

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

Formats the value using the given formatter.

impl<'__de, __A> Decode<'__de, Binary, __A> for ChannelId

where __A: Allocator,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Binary, Allocator = __A>,

Decode the current value.

impl<'__de, __A> Decode<'__de, Text, __A> for ChannelId

where __A: Allocator,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Text, Allocator = __A>,

Decode the current value.

impl Encode<Binary> for ChannelId

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = ChannelId

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Binary>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl Encode<Text> for ChannelId

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = ChannelId

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Text>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl Eq for ChannelId

impl From<ChannelId> for AtomicChannelId

fn from(id: ChannelId) -> Self

Converts to this type from the input type.

impl Hash for ChannelId

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 Ord for ChannelId

fn cmp(&self, other: &ChannelId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ChannelId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ChannelId

fn partial_cmp(&self, other: &ChannelId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ChannelId