Struct zx::MessageBufEtc

source ·
pub struct MessageBufEtc { /* private fields */ }
Expand description

A buffer for receiving messages from a channel.

This differs from MessageBuf in that it holds HandleInfo with extended handle information.

A MessageBufEtc is essentially a byte buffer and a vector of handle infos, but move semantics for “taking” handles requires special handling.

Note that for sending messages to a channel, the caller manages the buffers, using a plain byte slice and Vec<HandleDisposition>.

Implementations§

source§

impl MessageBufEtc

source

pub fn new() -> Self

Create a new, empty, message buffer.

source

pub fn new_with(v: Vec<u8>, h: Vec<HandleInfo>) -> Self

Create a new non-empty message buffer.

source

pub fn split_mut(&mut self) -> (&mut Vec<u8>, &mut Vec<HandleInfo>)

Splits apart the message buf into a vector of bytes and a vector of handle infos.

source

pub fn split(self) -> (Vec<u8>, Vec<HandleInfo>)

Splits apart the message buf into a vector of bytes and a vector of handle infos.

source

pub fn ensure_capacity_bytes(&mut self, n_bytes: usize)

Ensure that the buffer has the capacity to hold at least n_bytes bytes.

source

pub fn ensure_capacity_handle_infos(&mut self, n_handle_infos: usize)

Ensure that the buffer has the capacity to hold at least n_handles handle infos.

source

pub fn ensure_initialized_bytes(&mut self, n_bytes: usize)

Ensure that at least n_bytes bytes are initialized (0 fill).

source

pub fn shrink_bytes_to_fit(&mut self)

Ensure that the allocation for the message’s bytes is as small as possible.

source

pub fn bytes(&self) -> &[u8]

Get a reference to the bytes of the message buffer, as a &[u8] slice.

source

pub fn n_handle_infos(&self) -> usize

The number of handles in the message buffer. Note this counts the number available when the message was received; take_handle does not affect the count.

source

pub fn take_handle_info(&mut self, index: usize) -> Option<HandleInfo>

Take the handle at the specified index from the message buffer. If the method is called again with the same index, it will return None, as will happen if the index exceeds the number of handles available.

source

pub fn clear(&mut self)

Clear the bytes and handles contained in the buf. This will drop any contained handles, resulting in their resources being freed.

Trait Implementations§

source§

impl Debug for MessageBufEtc

source§

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

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

impl Default for MessageBufEtc

source§

fn default() -> MessageBufEtc

Returns the “default value” for a type. Read more

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, 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.