Struct fuchsia_zircon::Fifo

source ·
pub struct Fifo(/* private fields */);
Expand description

An object representing a Zircon fifo.

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

Implementations§

source§

impl Fifo

source

pub fn create( elem_count: usize, elem_size: usize ) -> 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 zx_fifo_create syscall.

source

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

Attempts to write some number of elements into the fifo. The length of bytes must be divisible by elem_size, which must match the fifo’s element size. On success, returns the number of elements actually written.

Wraps zx_fifo_write.

source

pub unsafe fn write_ptr( &self, elem_size: usize, bytes: *const u8, count: usize ) -> Result<usize, Status>

Attempts to write some number of elements into the fifo. bytes must be at least elem_size * count bytes long. On success, returns the number of elements actually written.

Wraps zx_fifo_write.

§Safety

The caller is responsible for ensuring bytes points to valid and initialized memory at least elem_size * count bytes long.

source

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

Attempts to read some number of elements out of the fifo. The length of bytes must be divisible by elem_size, which must match the fifo’s element size. On success, returns the number of elements actually read.

Wraps zx_fifo_read.

source

pub unsafe fn read_ptr( &self, elem_size: usize, bytes: *mut u8, count: usize ) -> Result<usize, Status>

Attempts to read some number of elements out of the fifo. bytes must be at least elem_size * count bytes long. On success, returns the number of elements actually read.

Wraps zx_fifo_read.

§Safety

The caller is responsible for ensuring bytes points to valid (albeit not necessarily initialized) memory at least elem_size * count bytes long.

Trait Implementations§

source§

impl AsHandleRef for Fifo

source§

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

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

fn raw_handle(&self) -> zx_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).
source§

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

Set and clear userspace-accessible signal bits on an object. Wraps the zx_object_signal syscall.
source§

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

Waits on a handle. Wraps the zx_object_wait_one syscall.
source§

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. zx_object_wait_async syscall.
source§

fn get_name(&self) -> Result<CString, Status>

Get the Property::NAME property for this object. Read more
source§

fn set_name(&self, name: &CStr) -> Result<(), Status>

Set the Property::NAME property for this object. Read more
source§

fn basic_info(&self) -> Result<HandleBasicInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.
source§

fn count_info(&self) -> Result<HandleCountInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.
source§

fn get_koid(&self) -> Result<Koid, Status>

Returns the koid (kernel object ID) for this handle.
source§

impl Debug for Fifo

source§

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

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

impl From<Fifo> for Handle

source§

fn from(x: Fifo) -> Handle

Converts to this type from the input type.
source§

impl From<Handle> for Fifo

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl HandleBased for Fifo

source§

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

Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.
source§

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 zx_handle_replace syscall.
source§

fn into_handle(self) -> Handle

Converts the value into its inner handle. Read more
source§

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation. Read more
source§

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle. Read more
source§

fn into_handle_based<H: HandleBased>(self) -> H

Creates an instance of another handle-based type from this value’s inner handle.
source§

fn from_handle_based<H: HandleBased>(h: H) -> Self

Creates an instance of this type from the inner handle of another handle-based type.
source§

fn is_invalid_handle(&self) -> bool

source§

impl Hash for Fifo

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Fifo

source§

fn cmp(&self, other: &Fifo) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Fifo

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Fifo

source§

fn partial_cmp(&self, other: &Fifo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Fifo

source§

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§

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.