Struct MessageId 

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

Available on crate feature api only.

A raw identifier for a message.

Implementations

impl MessageId

pub const ERROR_MESSAGE: Self

The message id for [ErrorMessage].

pub const CONNECT: Self

A connect of a channel.

pub const DISCONNECT: Self

A clean disconnect of a channel.

pub const SERVER_HELLO: Self

The first message the server sends to indicat that a connection is open.

pub const NEGOTIATE: Self

A request from the client to use a particular Format for the remainder of the connection.

See the [negotiation protocol] for how this is used.

pub const EMPTY: Self

The message id for an empty packet constructed using Packet::empty or RawPacket::empty.

Examples

use musli_web::api::MessageId;
use musli_web::web::{RawPacket, Packet};

let packet = RawPacket::empty();
assert_eq!(packet.id(), MessageId::EMPTY);

let packet = Packet::<()>::empty();
assert_eq!(packet.id(), MessageId::EMPTY);

pub const fn new(id: u16) -> Option<Self>

Construct a raw message id.

pub const fn get(&self) -> u16

Get a raw message identifier.

pub const unsafe fn new_unchecked(id: u16) -> Self

Construct a new message ID.

Safety

The caller must ensure that the provided id is non-zero.

Trait Implementations

impl Clone for MessageId

fn clone(&self) -> MessageId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MessageId

impl Debug for MessageId

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

Formats the value using the given formatter.

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

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 MessageId

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 Display for MessageId

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

Formats the value using the given formatter.

impl Encode<Binary> for MessageId

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 = MessageId

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 MessageId

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 = MessageId

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 MessageId

impl Hash for MessageId

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 MessageId

fn cmp(&self, other: &MessageId) -> 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 MessageId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MessageId

fn partial_cmp(&self, other: &MessageId) -> 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 MessageId