Struct SuspendToken 

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

An object representing a Zircon Suspend Token.

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

Implementations

impl SuspendToken

pub fn raw_handle(&self) -> u32

Return the handle’s integer value.

pub fn invalid() -> SuspendToken

pub fn is_invalid(&self) -> bool

pub fn into_raw(self) -> u32

Return the raw handle’s integer value without closing it when self is dropped.

pub fn unowned(&self) -> Unowned<'_, SuspendToken>

Returns an [Unowned] referring to this handle.

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

Returns a [HandleRef] referring to this handle.

pub fn duplicate_handle(&self, rights: Rights) -> Result<SuspendToken, Status>

Wraps the zx_handle_duplicate syscall.

pub fn replace_handle(self, rights: Rights) -> Result<SuspendToken, Status>

Wraps the zx_handle_replace syscall.

pub fn into_handle(self) -> NullableHandle

Converts the value into its inner handle.

pub fn signal( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Wraps the zx_object_signal syscall.

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

Wraps the zx_object_wait_one syscall.

pub fn wait_async( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>

Wraps the zx_object_wait_async syscall.

pub fn wait_item(&self, signals: Signals) -> WaitItem<'_>

Return a WaitItem for this handle and the provided signals to use with object_wait_many.

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

Wraps a call to the zx_object_get_property syscall for the ZX_PROP_NAME property.

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

Wraps a call to the zx_object_set_property syscall for the ZX_PROP_NAME property.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

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

Returns the [Koid] for the object referred to by this handle.

Trait Implementations

impl AsHandleRef for SuspendToken

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

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

impl Debug for SuspendToken

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

Formats the value using the given formatter.

impl From<Handle> for SuspendToken

fn from(handle: Handle) -> SuspendToken

Converts to this type from the input type.

impl From<NullableHandle> for SuspendToken

fn from(handle: NullableHandle) -> SuspendToken

Converts to this type from the input type.

impl From<SuspendToken> for NullableHandle

fn from(x: SuspendToken) -> NullableHandle

Converts to this type from the input type.

impl Hash for SuspendToken

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 SuspendToken

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

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

fn partial_cmp(&self, other: &SuspendToken) -> 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 TryFrom<SuspendToken> for Handle

type Error = Status

The type returned in the event of a conversion error.

fn try_from( x: SuspendToken, ) -> Result<Handle, <Handle as TryFrom<SuspendToken>>::Error>

Performs the conversion.

impl Eq for SuspendToken

impl StructuralPartialEq for SuspendToken