zx

Struct Signals

Source
pub struct Signals(/* private fields */);
Expand description

Signals that can be waited upon.

See Objects and signals in the Zircon kernel documentation. Note: the names of signals are still in flux.

Implementations§

Source§

impl Signals

Source

pub const NONE: Self = _

Source

pub const OBJECT_ALL: Self = _

Source

pub const USER_ALL: Self = _

Source

pub const OBJECT_0: Self = _

Source

pub const OBJECT_1: Self = _

Source

pub const OBJECT_2: Self = _

Source

pub const OBJECT_3: Self = _

Source

pub const OBJECT_4: Self = _

Source

pub const OBJECT_5: Self = _

Source

pub const OBJECT_6: Self = _

Source

pub const OBJECT_7: Self = _

Source

pub const OBJECT_8: Self = _

Source

pub const OBJECT_9: Self = _

Source

pub const OBJECT_10: Self = _

Source

pub const OBJECT_11: Self = _

Source

pub const OBJECT_12: Self = _

Source

pub const OBJECT_13: Self = _

Source

pub const OBJECT_14: Self = _

Source

pub const OBJECT_15: Self = _

Source

pub const OBJECT_16: Self = _

Source

pub const OBJECT_17: Self = _

Source

pub const OBJECT_18: Self = _

Source

pub const OBJECT_19: Self = _

Source

pub const OBJECT_20: Self = _

Source

pub const OBJECT_21: Self = _

Source

pub const OBJECT_22: Self = _

Source

pub const OBJECT_HANDLE_CLOSED: Self = _

Source

pub const USER_0: Self = _

Source

pub const USER_1: Self = _

Source

pub const USER_2: Self = _

Source

pub const USER_3: Self = _

Source

pub const USER_4: Self = _

Source

pub const USER_5: Self = _

Source

pub const USER_6: Self = _

Source

pub const USER_7: Self = _

Source

pub const OBJECT_READABLE: Self = _

Source

pub const OBJECT_WRITABLE: Self = _

Source

pub const OBJECT_PEER_CLOSED: Self = _

Source

pub const HANDLE_CLOSED: Self = _

Source

pub const EVENT_SIGNALED: Self = _

Source

pub const EVENTPAIR_SIGNALED: Self = _

Source

pub const EVENTPAIR_PEER_CLOSED: Self = _

Source

pub const TASK_TERMINATED: Self = _

Source

pub const CHANNEL_READABLE: Self = _

Source

pub const CHANNEL_WRITABLE: Self = _

Source

pub const CHANNEL_PEER_CLOSED: Self = _

Source

pub const CLOCK_STARTED: Self = _

Source

pub const CLOCK_UPDATED: Self = _

Source

pub const SOCKET_READABLE: Self = _

Source

pub const SOCKET_WRITABLE: Self = _

Source

pub const SOCKET_PEER_CLOSED: Self = _

Source

pub const SOCKET_PEER_WRITE_DISABLED: Self = _

Source

pub const SOCKET_WRITE_DISABLED: Self = _

Source

pub const SOCKET_READ_THRESHOLD: Self = _

Source

pub const SOCKET_WRITE_THRESHOLD: Self = _

Source

pub const RESOURCE_DESTROYED: Self = _

Source

pub const RESOURCE_READABLE: Self = _

Source

pub const RESOURCE_WRITABLE: Self = _

Source

pub const RESOURCE_CHILD_ADDED: Self = _

Source

pub const FIFO_READABLE: Self = _

Source

pub const FIFO_WRITABLE: Self = _

Source

pub const FIFO_PEER_CLOSED: Self = _

Source

pub const JOB_TERMINATED: Self = _

Source

pub const JOB_NO_JOBS: Self = _

Source

pub const JOB_NO_PROCESSES: Self = _

Source

pub const PROCESS_TERMINATED: Self = _

Source

pub const THREAD_TERMINATED: Self = _

Source

pub const THREAD_RUNNING: Self = _

Source

pub const THREAD_SUSPENDED: Self = _

Source

pub const LOG_READABLE: Self = _

Source

pub const LOG_WRITABLE: Self = _

Source

pub const TIMER_SIGNALED: Self = _

Source

pub const VMO_ZERO_CHILDREN: Self = _

Source§

impl Signals

Source

pub const fn empty() -> Self

Get a flags value with all bits unset.

Source

pub const fn all() -> Self

Get a flags value with all known bits set.

Source

pub const fn bits(&self) -> zx_signals_t

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

Source

pub const fn from_bits(bits: zx_signals_t) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

Source

pub const fn from_bits_truncate(bits: zx_signals_t) -> Self

Convert from a bits value, unsetting any unknown bits.

Source

pub const fn from_bits_retain(bits: zx_signals_t) -> Self

Convert from a bits value exactly.

Source

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

Source

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

Source

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

Source

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

Source

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

Source

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

Source

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

Source

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

Source

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

Source

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

Source

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

Source

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

Source

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

Source

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

Source§

impl Signals

Source

pub const fn iter(&self) -> Iter<Signals>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

Source

pub const fn iter_names(&self) -> IterNames<Signals>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations§

Source§

impl Binary for Signals

Source§

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

Formats the value using the given formatter. Read more
Source§

impl BitAnd for Signals

Source§

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

The bitwise and (&) of the bits in two flags values.

Source§

type Output = Signals

The resulting type after applying the & operator.
Source§

impl BitAndAssign for Signals

Source§

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

Source§

impl BitOr for Signals

Source§

fn bitor(self, other: Signals) -> Self

The bitwise or (|) of the bits in two flags values.

Source§

type Output = Signals

The resulting type after applying the | operator.
Source§

impl BitOrAssign for Signals

Source§

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

Source§

impl BitXor for Signals

Source§

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

The bitwise exclusive-or (^) of the bits in two flags values.

Source§

type Output = Signals

The resulting type after applying the ^ operator.
Source§

impl BitXorAssign for Signals

Source§

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

Source§

impl Clone for Signals

Source§

fn clone(&self) -> Signals

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Signals

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Extend<Signals> for Signals

Source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl Flags for Signals

Source§

const FLAGS: &'static [Flag<Signals>] = _

The set of defined flags.
Source§

type Bits = u32

The underlying bits type.
Source§

fn bits(&self) -> zx_signals_t

Get the underlying bits value. Read more
Source§

fn from_bits_retain(bits: zx_signals_t) -> Signals

Convert from a bits value exactly.
§

fn empty() -> Self

Get a flags value with all bits unset.
§

fn all() -> Self

Get a flags value with all known bits set.
§

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more
§

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.
§

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more
§

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more
§

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more
§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
§

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.
§

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.
§

fn insert(&mut self, other: Self)
where Self: Sized,

The bitwise or (|) of the bits in two flags values.
§

fn remove(&mut self, other: Self)
where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
§

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.
§

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

The bitwise and (&) of the bits in two flags values.
§

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

The bitwise or (|) of the bits in two flags values.
§

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

The intersection of a source flags value with the complement of a target flags value (&!). Read more
§

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

The bitwise exclusive-or (^) of the bits in two flags values.
§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
Source§

impl FromIterator<Signals> for Signals

Source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

Source§

impl Hash for Signals

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IntoIterator for Signals

Source§

type Item = Signals

The type of the elements being iterated over.
Source§

type IntoIter = Iter<Signals>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl LowerHex for Signals

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Not for Signals

Source§

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

Source§

type Output = Signals

The resulting type after applying the ! operator.
Source§

impl Octal for Signals

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Ord for Signals

Source§

fn cmp(&self, other: &Signals) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Signals

Source§

fn eq(&self, other: &Signals) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Signals

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl PublicFlags for Signals

Source§

type Primitive = u32

The type of the underlying storage.
Source§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
Source§

impl Sub for Signals

Source§

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

Source§

type Output = Signals

The resulting type after applying the - operator.
Source§

impl SubAssign for Signals

Source§

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

Source§

impl UpperHex for Signals

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for Signals

Source§

impl Eq for Signals

Source§

impl StructuralPartialEq for Signals

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.