Struct fizyr_rpc::MessageHeader

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

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

impl MessageHeader

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

Create a new request message header.

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

Create a new response message header.

pub fn error_response(request_id: u32) -> Self

Create a new error response message header.

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

Create a new requester update message header.

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

Create a new responder update message header.

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

Create a new stream message header.

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

Decode a message header from a byte slice.

The byte slice should NOT contain the message size.

Panic

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

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

Encode a message header into a byte slice.

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

impl Clone for MessageHeader

fn clone(&self) -> MessageHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MessageHeader

impl Debug for MessageHeader

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

Formats the value using the given formatter.

impl Eq for MessageHeader

impl Hash for MessageHeader

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for MessageHeader

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MessageHeader> for MessageHeader

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

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

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

This method tests for !=.

impl PartialOrd<MessageHeader> for MessageHeader

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for MessageHeader

impl StructuralPartialEq for MessageHeader