Struct Channel

pub struct Channel<T: ?Sized + 'static>(/* private fields */);

Implements a message channel through the Fuchsia Driver Runtime

Implementations

impl<T: ?Sized + 'static> Channel<T>

pub fn create() -> Result<(Self, Self), Status>

Creates a new channel pair that can be used to send messages of type T between threads managed by the driver runtime.

pub fn into_driver_handle(self) -> DriverHandle

Takes the inner handle to the channel. The caller is responsible for ensuring that the handle is freed.

pub unsafe fn from_driver_handle(handle: DriverHandle) -> Self

Initializes a Channel object from the given DriverHandle, assuming that it is a channel of type T.

Safety

The caller must ensure that the handle is a Channel-based handle that is using type T as its wire format.

pub fn write(&self, message: Message<T>) -> Result<(), Status>

Writes the Message given to the channel. This will complete asynchronously and can’t be cancelled.

The channel will take ownership of the data and handles passed in,

pub fn write_with<F>(&self, arena: Arena, f: F) -> Result<(), Status>

where F: for<'a> FnOnce(&'a Arena) -> (Option<ArenaBox<'a, T>>, Option<ArenaBox<'a, [Option<MixedHandle>]>>),

Shorthand for calling Self::write with the result of Message::new_with

pub fn write_with_data<F>(&self, arena: Arena, f: F) -> Result<(), Status>

where F: for<'a> FnOnce(&'a Arena) -> ArenaBox<'a, T>,

Shorthand for calling Self::write with the result of Message::new_with

impl<T> Channel<T>

pub fn try_read<'a>(&self) -> Result<Option<Message<T>>, Status>

Attempts to read an object of type T and a handle set from the channel

pub async fn read( &self, dispatcher: DispatcherRef<'_>, ) -> Result<Option<Message<T>>, Status>

Reads an object of type T and a handle set from the channel asynchronously

impl Channel<[u8]>

pub fn try_read_bytes<'a>(&self) -> Result<Option<Message<[u8]>>, Status>

Attempts to read an object of type T and a handle set from the channel

pub async fn read_bytes( &self, dispatcher: DispatcherRef<'_>, ) -> Result<Option<Message<[u8]>>, Status>

Reads a slice of type T and a handle set from the channel asynchronously

Trait Implementations

impl<T: Debug + ?Sized + 'static> Debug for Channel<T>

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

Formats the value using the given formatter.

impl<T> From<Channel<T>> for MixedHandle

fn from(value: Channel<T>) -> Self

Converts to this type from the input type.

impl<T: Hash + ?Sized + 'static> Hash for Channel<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + ?Sized + 'static> Ord for Channel<T>

fn cmp(&self, other: &Channel<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + ?Sized + 'static> PartialEq for Channel<T>

fn eq(&self, other: &Channel<T>) -> bool

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

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<T: PartialOrd + ?Sized + 'static> PartialOrd for Channel<T>

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + ?Sized + 'static> Eq for Channel<T>

impl<T: ?Sized + 'static> StructuralPartialEq for Channel<T>