Struct Fifo

pub struct Fifo(/* private fields */);

Expand description

An object representing a Magenta fifo.

As essentially a subtype of Handle, it can be freely interconverted.

Implementations§

impl Fifo

pub fn create( elem_count: u32, elem_size: u32, options: FifoOpts, ) -> Result<(Fifo, Fifo), Status>

Create a pair of fifos and return their endpoints. Writing to one endpoint enqueues an element into the fifo from which the opposing endpoint reads. Wraps the mx_fifo_create syscall.

pub fn write(&self, bytes: &[u8]) -> Result<u32, Status>

Attempts to write some number of elements into the fifo. The number of bytes written will be rounded down to a multiple of the fifo’s element size. Return value (on success) is number of elements actually written.

Wraps mx_fifo_write.

pub fn read(&self, bytes: &mut [u8]) -> Result<u32, Status>

Attempts to read some number of elements out of the fifo. The number of bytes read will always be a multiple of the fifo’s element size. Return value (on success) is number of elements actually read.

Wraps mx_fifo_read.

Trait Implementations§

impl AsHandleRef for Fifo

fn as_handle_ref(&self) -> HandleRef<'_>

Get a reference to the handle. One important use of such a reference is for object_wait_many.

fn raw_handle(&self) -> mx_handle_t

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).

fn signal_handle( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the mx_object_signal syscall.

fn wait_handle( &self, signals: Signals, deadline: mx_time_t, ) -> Result<Signals, Status>

Waits on a handle. Wraps the mx_object_wait_one syscall.

fn wait_async_handle( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>

Causes packet delivery on the given port when the object changes state and matches signals. mx_object_wait_async syscall.

impl Debug for Fifo

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

Formats the value using the given formatter. Read more

impl From<Handle> for Fifo

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl HandleBased for Fifo

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the mx_handle_duplicate syscall.

fn replace_handle(self, rights: Rights) -> Result<Self, Status>

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the mx_handle_replace syscall.

impl Into<Handle> for Fifo

fn into(self) -> Handle

Converts this type into the (usually inferred) input type.

impl PartialEq for Fifo

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Fifo

impl StructuralPartialEq for Fifo

Auto Trait Implementations§

impl Freeze for Fifo

impl RefUnwindSafe for Fifo

impl Send for Fifo

impl Sync for Fifo

impl Unpin for Fifo

impl UnwindSafe for Fifo

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.