Struct itron_solid_asp3::messagebuffer::MessageBuffer

pub struct MessageBuffer(_);

This is supported on crate feature unstable and (crate features asp3 and messagebuf, or crate features solid_asp3 and messagebuf, or crate feature none) and crate feature dcre and non-crate feature asp3 only.

An owned message buffer.

Deletes the message buffer automatically when dropped. The destructor will panic if the deletion fails.

Implementations

impl MessageBuffer

pub fn build(
) -> Builder<__block_size_is_not_specified__, __block_count_is_not_specified__>

acre_mbf: Create a builder for MessageBuffer.

Examples

use itron::messagebuffer::MessageBuffer;
let buffer = MessageBuffer::build()
    .capacity(128)
    .max_message_size(64)
    .finish()
    .expect("failed to create a message buffer");

buffer.as_ref().send(&[0u8; 32])
   .expect("failed to send a message");

let mut got_message = [0u8; 64];
let got_message_len = unsafe {
    buffer
        .as_ref()
        .recv(&mut got_message)
        .expect("failed to receive a message")
};
assert_eq!(got_message_len, 32);

impl MessageBuffer

pub const unsafe fn from_raw_nonnull(id: NonNullID) -> Self

Construct a MessageBuffer from a raw object ID.

Safety

See Object ID Wrappers.

pub const fn leak<'a>(self) -> MessageBufferRef<'a>

Consume and “leak” self, returning a reference MessageBufferRef<'a>.

pub const fn as_raw(&self) -> ID

Get the raw object ID.

pub const fn as_raw_nonnull(&self) -> NonNullID

Get the raw object ID as abi::NonNullID.

pub const fn as_ref(&self) -> MessageBufferRef<'_>

Borrow MessageBuffer as MessageBufferRef.

Use this to perform operations on message buffers because most of the methods are implemented on MessageBufferRef but not MessageBuffer.

Trait Implementations

impl Debug for MessageBuffer

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

Formats the value using the given formatter.

impl Drop for MessageBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<MessageBuffer> for MessageBuffer

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

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

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

This method tests for !=.

impl Eq for MessageBuffer

impl StructuralEq for MessageBuffer

impl StructuralPartialEq for MessageBuffer