Struct Channel

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

An I/O object representing a Channel.

Implementations

impl Channel

pub fn from_channel(channel: Channel) -> Self

Creates a new Channel from a previously-created zx::Channel.

Panics

If called outside the context of an active async executor.

pub fn into_zx_channel(self) -> Channel

Consumes self and returns the underlying zx::Channel.

pub fn is_closed(&self) -> bool

Returns true if the channel received the OBJECT_PEER_CLOSED signal.

pub fn on_closed(&self) -> OnSignalsRef<'_>

Returns a future that completes when is_closed() is true.

pub fn read( &self, cx: &mut Context<'_>, bytes: &mut Vec<u8>, handles: &mut Vec<Handle>, ) -> Poll<Result<(), Status>>

Receives a message on the channel and registers this Channel as needing a read on receiving a zx::Status::SHOULD_WAIT.

Identical to recv_from except takes separate bytes and handles buffers rather than a single MessageBuf.

pub fn read_etc( &self, cx: &mut Context<'_>, bytes: &mut Vec<u8>, handles: &mut Vec<HandleInfo>, ) -> Poll<Result<(), Status>>

Receives a message on the channel and registers this Channel as needing a read on receiving a zx::Status::SHOULD_WAIT.

Identical to recv_etc_from except takes separate bytes and handles buffers rather than a single MessageBufEtc.

pub fn recv_from( &self, cx: &mut Context<'_>, buf: &mut MessageBuf, ) -> Poll<Result<(), Status>>

Receives a message on the channel and registers this Channel as needing a read on receiving a zx::Status::SHOULD_WAIT.

pub fn recv_etc_from( &self, cx: &mut Context<'_>, buf: &mut MessageBufEtc, ) -> Poll<Result<(), Status>>

Receives a message on the channel and registers this Channel as needing a read on receiving a zx::Status::SHOULD_WAIT.

pub fn recv_msg<'a>(&'a self, buf: &'a mut MessageBuf) -> RecvMsg<'a>

Creates a future that receive a message to be written to the buffer provided.

The returned future will return after a message has been received on this socket and been placed into the buffer.

pub fn recv_etc_msg<'a>(&'a self, buf: &'a mut MessageBufEtc) -> RecvEtcMsg<'a>

Creates a future that receive a message to be written to the buffer provided.

The returned future will return after a message has been received on this socket and been placed into the buffer.

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

Writes a message into the channel.

pub fn write_etc( &self, bytes: &[u8], handles: &mut [HandleDisposition<'_>], ) -> Result<(), Status>

Writes a message into the channel.

Trait Implementations

impl AsHandleRef for Channel

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

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.

fn wait_handle( &self, signals: Signals, deadline: Instant<MonotonicTimeline>, ) -> WaitResult

Waits on a handle. Wraps the zx_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. zx_object_wait_async syscall.

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

Get the Property::NAME property for this object.

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

Set the Property::NAME property for this object.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

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

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

impl AsRef<Channel> for Channel

fn as_ref(&self) -> &Channel

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Channel

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

Formats the value using the given formatter.

impl From<Channel> for Channel

fn from(channel: Channel) -> Channel

Converts to this type from the input type.