Struct Message

pub struct Message {
    pub payload_len: usize,
    pub user_defined: u32,
    pub is_fin: bool,
    pub is_continuation: bool,
    pub is_padding: bool,
    /* private fields */
}

Contains coordinates to some payload at particular point in time. Messages are consumer in a ‘lazily’ way that’s why it’s safe to clone() and pass them around. When message is read (consumed) it can result in overrun error if the producer has lapped around.

Fields

payload_len: usize

Message length.

user_defined: u32

User defined field.

is_fin: bool

Indicates final message fragment.

is_continuation: bool

Indicates continuation frame

is_padding: bool

Indicates padding frame.

Implementations

impl Message

pub fn read(&self, buf: &mut [u8]) -> Result<usize>

Read the message into specified buffer. It will return error if the provided buffer is too small. Will also return error if at any point the producer has overrun this consumer. On success, it will return the number of bytes written to the buffer.

Examples

use bcast::Message;

fn consume_message(msg: &Message) {
    let mut payload = [0u8; 1024];
    // read into provided buffer (error means overrun)
    let len = msg.read(&mut payload).unwrap();
    // process payload
    // ...
}

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.