Struct EventPair

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

Expand description

An object representing a Magenta event pair.

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

Implementations§

impl EventPair

pub fn create(options: EventPairOpts) -> Result<(EventPair, EventPair), Status>

Create an event pair, a pair of objects which can signal each other. Wraps the mx_eventpair_create syscall.

Trait Implementations§

impl AsHandleRef for EventPair

fn as_handle_ref(&self) -> HandleRef<'_>

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

fn raw_handle(&self) -> mx_handle_t

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).

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

Set and clear userspace-accessible signal bits on an object. Wraps the mx_object_signal syscall.

fn wait_handle( &self, signals: Signals, deadline: mx_time_t, ) -> Result<Signals, Status>

Waits on a handle. Wraps the mx_object_wait_one syscall.

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

Causes packet delivery on the given port when the object changes state and matches signals. mx_object_wait_async syscall.

impl Cookied for EventPair

fn get_cookie(&self, scope: &HandleRef<'_>) -> Result<u64, Status>

Get the cookie attached to this object, if any. Wraps the mx_object_get_cookie syscall.

fn set_cookie(&self, scope: &HandleRef<'_>, cookie: u64) -> Result<(), Status>

Attach an opaque cookie to this object with the given scope. The cookie may be read or changed in future only with the same scope. Wraps the mx_object_set_cookie syscall.

impl Debug for EventPair

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

Formats the value using the given formatter. Read more

impl From<Handle> for EventPair

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl HandleBased for EventPair

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

Duplicate a handle, possibly reducing the rights available. Wraps the mx_handle_duplicate syscall.

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

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the mx_handle_replace syscall.

impl Into<Handle> for EventPair

fn into(self) -> Handle

Converts this type into the (usually inferred) input type.

impl PartialEq for EventPair

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

impl Peered for EventPair

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

Set and clear userspace-accessible signal bits on the object’s peer. Wraps the mx_object_signal_peer syscall.

impl Eq for EventPair

impl StructuralPartialEq for EventPair

Auto Trait Implementations§

impl Freeze for EventPair

impl RefUnwindSafe for EventPair

impl Send for EventPair

impl Sync for EventPair

impl Unpin for EventPair

impl UnwindSafe for EventPair

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.