#[repr(C)]
pub struct MessageHeader { pub message_type: MessageType, pub request_id: u32, pub service_id: i32, }
Expand description

A message header.

Fields§

§message_type: MessageType

The message type.

§request_id: u32

The request that the message is part of.

Unused for stream messages.

§service_id: i32

The service that the message is for.

For request messages, this indicates the service being requested.

For response messages this indicates success or failure.

For update messages this indicates the type of update.

Implementations§

source§

impl MessageHeader

source

pub fn request(request_id: u32, service_id: i32) -> Self

Create a new request message header.

source

pub fn response(request_id: u32, service_id: i32) -> Self

Create a new response message header.

source

pub fn error_response(request_id: u32) -> Self

Create a new error response message header.

source

pub fn requester_update(request_id: u32, service_id: i32) -> Self

Create a new requester update message header.

source

pub fn responder_update(request_id: u32, service_id: i32) -> Self

Create a new responder update message header.

source

pub fn stream(request_id: u32, service_id: i32) -> Self

Create a new stream message header.

source

pub fn decode(buffer: &[u8], endian: Endian) -> Result<Self, Error>

Decode a message header from a byte slice using the given endianness for the header fields.

The byte slice should NOT contain the message size.

Panic

This function panics if the buffer does not contain a full header.

source

pub fn encode(&self, buffer: &mut [u8], endian: Endian)

Encode a message header into a byte slice using the given endianness for the header fields.

This will NOT add a message size (which would be impossible even if we wanted to).

Panic

This function panics if the buffer is not large enough to hold a full header.

Trait Implementations§

source§

impl Clone for MessageHeader

source§

fn clone(&self) -> MessageHeader

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for MessageHeader

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for MessageHeader

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for MessageHeader

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for MessageHeader

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for MessageHeader

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Copy for MessageHeader

source§

impl Eq for MessageHeader

source§

impl StructuralEq for MessageHeader

source§

impl StructuralPartialEq for MessageHeader

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.