Enum WaitResult

pub enum WaitResult {
    Ok(Signals),
    TimedOut(Signals),
    Canceled(Signals),
    Err(Status),
}

Result from HandleRef::wait and AsHandleRef::wait_handle. Conveys the result of the zx_object_wait_one syscall and the signals that were asserted on the object when the syscall completed.

Variants

Ok(Signals)

The syscall completed with ZX_OK and the provided signals were observed.

TimedOut(Signals)

The syscall completed with ZX_ERR_TIMED_OUT and the provided signals were observed. These signals may reflect state changes that occurred after the deadline passed, but before the syscall returned.

Canceled(Signals)

The syscall completed with ZX_ERR_CANCELED and the provided signals were observed. The signals will include ZX_SIGNAL_HANDLE_CLOSED.

Note that the state of these signals may be racy and difficult to interpret. Often, the correct behavior in this case is to treat this as an error.

Err(Status)

The syscall completed with a status other than ZX_OK, ZX_ERR_TIMED_OUT, or ZX_ERR_CANCELED. No signals are returned in this scenario.

Implementations

impl WaitResult

pub const fn to_result(self) -> Result<Signals, Status>

Convert this WaitResult into a Result<Signals, Status>. The signals are discarded in all cases except WaitResult::Ok.

pub const fn is_ok(&self) -> bool

pub const fn is_err(&self) -> bool

pub fn map<U, F>(self, op: F) -> Result<U, Status>

where F: FnOnce(Signals) -> U,

pub fn map_err<F, O>(self, op: O) -> Result<Signals, F>

where O: FnOnce(Status) -> F,

pub fn expect(self, msg: &str) -> Signals

pub fn expect_err(self, msg: &str) -> Status

pub fn unwrap(self) -> Signals

Trait Implementations

impl Clone for WaitResult

fn clone(&self) -> WaitResult

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WaitResult

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

Formats the value using the given formatter.

impl Hash for WaitResult

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

where __H: Hasher,

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 Ord for WaitResult

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

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

fn partial_cmp(&self, other: &WaitResult) -> 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 Copy for WaitResult

impl Eq for WaitResult

impl StructuralPartialEq for WaitResult