Struct fidl::handle::fuchsia_handles::Fifo

source ·
pub struct Fifo<R = UnspecifiedFifoElement, W = R>(/* private fields */);
Expand description

An object representing a Zircon fifo.

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

Encodes the element type in the type. Defaults to () for the entry type to allow for untyped IPC. Use Fifo::cast() to convert an IPC-transferred fifo to one of the specific type required that will support reads and writes.

Implementations§

source§

impl<R, W> Fifo<R, W>
where R: IntoBytes + FromBytes, W: IntoBytes + FromBytes,

source

pub fn create(elem_count: usize) -> Result<(Fifo<R, W>, Fifo<W, R>), 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, buf: &[W]) -> Result<usize, Status>

Attempts to write some number of elements into the fifo. On success, returns the number of elements actually written.

Wraps zx_fifo_write.

source

pub fn write_one(&self, elem: &W) -> Result<(), Status>

Attempts to write a single element into the fifo.

Wraps zx_fifo_write.

source

pub unsafe fn write_raw( &self, buf: *const W, count: usize, ) -> Result<usize, Status>

Attempts to write some number of elements into the fifo. On success, returns the number of elements actually written.

Wraps zx_fifo_write.

§Safety

The caller is responsible for ensuring buf is valid to write to for count elements.

source

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

Attempts to read some elements out of the fifo. On success, returns the number of elements actually read.

Wraps zx_fifo_read.

source

pub fn read_one(&self) -> Result<R, Status>

Attempts to read a single element out of the fifo.

Wraps zx_fifo_read.

source

pub fn read_uninit( &self, bytes: &mut [MaybeUninit<R>], ) -> Result<&mut [R], Status>

Attempts to read some number of elements out of the fifo. On success, returns a slice of initialized elements.

Wraps zx_fifo_read.

source

pub unsafe fn read_raw( &self, buf: *mut R, count: usize, ) -> Result<usize, Status>

Attempts to read some number of elements out of the fifo. 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 len bytes long.

source§

impl Fifo

source

pub fn cast<R2, W2>(self) -> Fifo<R2, W2>

Give a Fifo specific read/write types. The size of R2 and W2 must match the element size the underlying handle was created with for reads and writes to succeed.

source§

impl<R, W> Fifo<R, W>

source

pub fn downcast(self) -> Fifo

Convert a fifo from having a specific element type to a fifo without any element type that will not support reads or writes.

Trait Implementations§

source§

impl<R, W> AsHandleRef for Fifo<R, W>

source§

fn as_handle_ref(&self) -> Unowned<'_, Handle>

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

fn raw_handle(&self) -> u32

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: Instant<MonotonicTimeline>, ) -> 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<Name, Status>

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

fn set_name(&self, name: &Name) -> 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<R, W> Debug for Fifo<R, W>

source§

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

Formats the value using the given formatter. Read more
§

impl<R, W> From<Fifo<R, W>> for Fifo<R, W>

§

fn from(fifo: Fifo<R, W>) -> Fifo<R, W>

Converts to this type from the input type.
source§

impl<R, W> From<Fifo<R, W>> for Handle

source§

fn from(x: Fifo<R, W>) -> Handle

Converts to this type from the input type.
source§

impl<R, W> From<Fifo> for Fifo<R, W>
where R: FromBytes + IntoBytes, W: FromBytes + IntoBytes,

source§

fn from(untyped: Fifo) -> Fifo<R, W>

Converts to this type from the input type.
source§

impl<R, W> From<Handle> for Fifo<R, W>

source§

fn from(handle: Handle) -> Fifo<R, W>

Converts to this type from the input type.
source§

impl<R, W> HandleBased for Fifo<R, W>

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) -> u32

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>(self) -> H
where H: HandleBased,

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

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

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

fn is_invalid_handle(&self) -> bool

source§

impl<R, W> Hash for Fifo<R, W>

source§

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

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<R, W> Ord for Fifo<R, W>

source§

fn cmp(&self, other: &Fifo<R, W>) -> 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<R, W> PartialEq for Fifo<R, W>

source§

fn eq(&self, other: &Fifo<R, W>) -> 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<R, W> PartialOrd for Fifo<R, W>

source§

fn partial_cmp(&self, other: &Fifo<R, W>) -> 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<R, W> Eq for Fifo<R, W>

Auto Trait Implementations§

§

impl<R, W> Freeze for Fifo<R, W>

§

impl<R, W> RefUnwindSafe for Fifo<R, W>

§

impl<R, W> Send for Fifo<R, W>
where R: Send, W: Send,

§

impl<R, W> Sync for Fifo<R, W>
where R: Sync, W: Sync,

§

impl<R, W> Unpin for Fifo<R, W>
where R: Unpin, W: Unpin,

§

impl<R, W> UnwindSafe for Fifo<R, W>
where R: UnwindSafe, W: UnwindSafe,

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> EncodableAsHandle for T
where T: HandleBased,

§

type Dialect = DefaultFuchsiaResourceDialect

What resource dialect can encode this object as a handle.
source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more