Struct fast_rpc::protocol::FastMessage

pub struct FastMessage {
    pub msg_type: FastMessageType,
    pub status: FastMessageStatus,
    pub id: u32,
    pub msg_size: Option<usize>,
    pub data: FastMessageData,
}

Represents a Fast message including the header and data payload

Fields

msg_type: FastMessageType

The Type field of the Fast message

status: FastMessageStatus

The Status field of the Fast message

id: u32

The Fast message identifier

msg_size: Option<usize>

The length in bytes of the Fast message data payload

data: FastMessageData

The data payload of the Fast message

Methods

impl FastMessage

pub fn parse(buf: &[u8]) -> Result<FastMessage, FastParseError>

Parse a byte buffer into a FastMessage. Returns a FastParseError if the available bytes cannot be parsed to a FastMessage.

pub fn check_buffer_size(buf: &[u8]) -> Result<(), FastParseError>

Check that the provided byte buffer contains at least FP_HEADER_SZ bytes. Returns a FastParseError if this is not the case.

pub fn parse_header(buf: &[u8]) -> Result<FastMessageHeader, FastParseError>

Parse a portion of a byte buffer into a FastMessageHeader. Returns a FastParseError if the available bytes cannot be parsed to a FastMessageHeader.

pub fn data(msg_id: u32, data: FastMessageData) -> FastMessage

Returns a FastMessage that represents a Fast protocol DATA message with the provided message identifer and data payload.

pub fn end(msg_id: u32, method: String) -> FastMessage

Returns a FastMessage that represents a Fast protocol END message with the provided message identifer. The method parameter is used in the otherwise empty data payload.

pub fn error(msg_id: u32, data: FastMessageData) -> FastMessage

Returns a FastMessage that represents a Fast protocol ERROR message with the provided message identifer and data payload.

Trait Implementations

impl Clone for FastMessage

fn clone(&self) -> FastMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FastMessage

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

Formats the value using the given formatter.

impl PartialEq<FastMessage> for FastMessage

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.