Struct RWHandle

pub struct RWHandle<T> { /* private fields */ }

A Handle that receives notifications when it is readable/writable.

Implementations

impl<T> RWHandle<T>

where T: AsHandleRef,

pub fn new(handle: T) -> Self

Creates a new RWHandle object which will receive notifications when the underlying handle becomes readable, writable, or closes.

Panics

If called outside the context of an active async executor.

pub fn get_ref(&self) -> &T

Returns a reference to the underlying handle.

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying handle.

pub fn into_inner(self) -> T

Consumes self and returns the underlying handle.

pub fn is_closed(&self) -> bool

Returns true if the object received the OBJECT_PEER_CLOSED signal.

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

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

Trait Implementations

impl<T> ReadableHandle for RWHandle<T>

where T: AsHandleRef,

fn poll_readable( &self, cx: &mut Context<'_>, ) -> Poll<Result<ReadableState, Status>>

If the object is ready for reading, returns Ready with the readable state. If the implementor returns Pending, it should first ensure that need_readable is called.

fn need_readable(&self, cx: &mut Context<'_>) -> Poll<Result<(), Status>>

Arranges for the current task to be woken when the object receives an OBJECT_READABLE or OBJECT_PEER_CLOSED signal. This can return Poll::Ready if the object has already been signaled in which case the waker will not be woken and it is the caller’s responsibility to not lose the signal.

impl<T> WritableHandle for RWHandle<T>

where T: AsHandleRef,

fn poll_writable( &self, cx: &mut Context<'_>, ) -> Poll<Result<WritableState, Status>>

If the object is ready for writing, returns Ready with the writable state. If the implementor returns Pending, it should first ensure that need_writable is called.

fn need_writable(&self, cx: &mut Context<'_>) -> Poll<Result<(), Status>>

Arranges for the current task to be woken when the object receives an OBJECT_WRITABLE or OBJECT_PEER_CLOSED signal. This can return Poll::Ready if the object has already been signaled in which case the waker will not be woken and it is the caller’s responsibility to not lose the signal.