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§

§

impl Signals

pub const NONE: Signals = _

pub const OBJECT_ALL: Signals = _

pub const USER_ALL: Signals = _

pub const OBJECT_0: Signals = _

pub const OBJECT_1: Signals = _

pub const OBJECT_2: Signals = _

pub const OBJECT_3: Signals = _

pub const OBJECT_4: Signals = _

pub const OBJECT_5: Signals = _

pub const OBJECT_6: Signals = _

pub const OBJECT_7: Signals = _

pub const OBJECT_8: Signals = _

pub const OBJECT_9: Signals = _

pub const OBJECT_10: Signals = _

pub const OBJECT_11: Signals = _

pub const OBJECT_12: Signals = _

pub const OBJECT_13: Signals = _

pub const OBJECT_14: Signals = _

pub const OBJECT_15: Signals = _

pub const OBJECT_16: Signals = _

pub const OBJECT_17: Signals = _

pub const OBJECT_18: Signals = _

pub const OBJECT_19: Signals = _

pub const OBJECT_20: Signals = _

pub const OBJECT_21: Signals = _

pub const OBJECT_22: Signals = _

pub const OBJECT_HANDLE_CLOSED: Signals = _

pub const USER_0: Signals = _

pub const USER_1: Signals = _

pub const USER_2: Signals = _

pub const USER_3: Signals = _

pub const USER_4: Signals = _

pub const USER_5: Signals = _

pub const USER_6: Signals = _

pub const USER_7: Signals = _

pub const OBJECT_READABLE: Signals = _

pub const OBJECT_WRITABLE: Signals = _

pub const OBJECT_PEER_CLOSED: Signals = _

pub const HANDLE_CLOSED: Signals = _

pub const EVENT_SIGNALED: Signals = _

pub const EVENTPAIR_SIGNALED: Signals = _

pub const EVENTPAIR_PEER_CLOSED: Signals = _

pub const TASK_TERMINATED: Signals = _

pub const CHANNEL_READABLE: Signals = _

pub const CHANNEL_WRITABLE: Signals = _

pub const CHANNEL_PEER_CLOSED: Signals = _

pub const CLOCK_STARTED: Signals = _

pub const SOCKET_READABLE: Signals = _

pub const SOCKET_WRITABLE: Signals = _

pub const SOCKET_PEER_CLOSED: Signals = _

pub const SOCKET_PEER_WRITE_DISABLED: Signals = _

pub const SOCKET_WRITE_DISABLED: Signals = _

pub const SOCKET_READ_THRESHOLD: Signals = _

pub const SOCKET_WRITE_THRESHOLD: Signals = _

pub const RESOURCE_DESTROYED: Signals = _

pub const RESOURCE_READABLE: Signals = _

pub const RESOURCE_WRITABLE: Signals = _

pub const RESOURCE_CHILD_ADDED: Signals = _

pub const FIFO_READABLE: Signals = _

pub const FIFO_WRITABLE: Signals = _

pub const FIFO_PEER_CLOSED: Signals = _

pub const JOB_TERMINATED: Signals = _

pub const JOB_NO_JOBS: Signals = _

pub const JOB_NO_PROCESSES: Signals = _

pub const PROCESS_TERMINATED: Signals = _

pub const THREAD_TERMINATED: Signals = _

pub const THREAD_RUNNING: Signals = _

pub const THREAD_SUSPENDED: Signals = _

pub const LOG_READABLE: Signals = _

pub const LOG_WRITABLE: Signals = _

pub const TIMER_SIGNALED: Signals = _

pub const VMO_ZERO_CHILDREN: Signals = _

pub const fn empty() -> Signals

Returns an empty set of flags.

pub const fn all() -> Signals

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<Signals>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Signals

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Signals

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Signals

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations§

§

impl Binary for Signals

§

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

Formats the value using the given formatter.
§

impl BitAnd for Signals

§

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

Returns the intersection between the two sets of flags.

§

type Output = Signals

The resulting type after applying the & operator.
§

impl BitAndAssign for Signals

§

fn bitand_assign(&mut self, other: Signals)

Disables all flags disabled in the set.

§

impl BitOr for Signals

§

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

Returns the union of the two sets of flags.

§

type Output = Signals

The resulting type after applying the | operator.
§

impl BitOrAssign for Signals

§

fn bitor_assign(&mut self, other: Signals)

Adds the set of flags.

§

impl BitXor for Signals

§

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

Returns the left flags, but with all the right flags toggled.

§

type Output = Signals

The resulting type after applying the ^ operator.
§

impl BitXorAssign for Signals

§

fn bitxor_assign(&mut self, other: Signals)

Toggles the set of flags.

§

impl Clone for Signals

§

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
§

impl Debug for Signals

§

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

Formats the value using the given formatter. Read more
§

impl Extend<Signals> for Signals

§

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

Extends a collection with the contents of an iterator. Read more
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
§

impl FromIterator<Signals> for Signals

§

fn from_iter<T>(iterator: T) -> Signalswhere T: IntoIterator<Item = Signals>,

Creates a value from an iterator. Read more
§

impl Hash for Signals

§

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

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
§

impl LowerHex for Signals

§

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

Formats the value using the given formatter.
§

impl Not for Signals

§

fn not(self) -> Signals

Returns the complement of this set of flags.

§

type Output = Signals

The resulting type after applying the ! operator.
§

impl Octal for Signals

§

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

Formats the value using the given formatter.
§

impl Ord for Signals

§

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) -> Selfwhere Self: Sized,

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

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

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

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for Signals

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl PartialOrd for Signals

§

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

This method 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

This method 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

This method 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

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

impl Sub for Signals

§

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

Returns the set difference of the two sets of flags.

§

type Output = Signals

The resulting type after applying the - operator.
§

impl SubAssign for Signals

§

fn sub_assign(&mut self, other: Signals)

Disables all flags enabled in the set.

§

impl UpperHex for Signals

§

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

Formats the value using the given formatter.
§

impl Copy for Signals

§

impl Eq for Signals

§

impl StructuralEq for Signals

§

impl StructuralPartialEq for Signals

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Encode<Ambiguous1> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> Encode<Ambiguous2> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more