Struct base::event::Event

pub struct Event(pub(crate) PlatformEvent);

An inter-process event wait/notify mechanism. Loosely speaking: Writes signal the event. Reads block until the event is signaled and then clear the signal.

Supports multiple simultaneous writers (i.e. signalers) but only one simultaneous reader (i.e. waiter). The behavior of multiple readers is undefined in cross platform code.

Multiple Events can be polled at once via WaitContext.

Implementation notes:

• Uses eventfd on Linux.
• Uses synchapi event objects on Windows.
• The Event and WaitContext APIs together cannot easily be implemented with the same semantics on all platforms. In particular, it is difficult to support multiple readers, so only a single reader is allowed for now. Multiple readers will result in undefined behavior.

Tuple Fields

0: PlatformEvent

Implementations

impl Event

pub fn new() -> Result<Event>

Creates new event in an unsignaled state.

pub fn signal(&self) -> Result<()>

Signals the event.

pub fn wait(&self) -> Result<()>

Blocks until the event is signaled and clears the signal.

It is undefined behavior to wait on an event from multiple threads or processes simultaneously.

pub fn wait_timeout(&self, timeout: Duration) -> Result<EventWaitResult>

Blocks until the event is signaled and clears the signal, or until the timeout duration expires.

It is undefined behavior to wait on an event from multiple threads or processes simultaneously.

pub fn reset(&self) -> Result<()>

Clears the event without blocking.

If the event is not signaled, this has no effect and returns immediately.

pub fn try_clone(&self) -> Result<Event>

Clones the event. The event’s state is shared between cloned instances.

The documented caveats for Event also apply to a set of cloned instances, e.g., it is undefined behavior to clone an event and then call Event::wait simultaneously on both objects.

Implementation notes:

• Linux: The cloned instance uses a separate file descriptor.
• Windows: The cloned instance uses a separate handle.

Trait Implementations

impl AsRawDescriptor for Event

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventExt for Event

fn write_count(&self, v: u64) -> Result<()>

Adds v to the eventfd’s count, blocking until this won’t overflow the count.

fn read_count(&self) -> Result<u64>

Blocks until the the eventfd’s count is non-zero, then resets the count to zero.

impl From<Event> for SafeDescriptor

fn from(evt: Event) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for Event

fn from(sd: SafeDescriptor) -> Self

Converts to this type from the input type.

impl FromRawDescriptor for Event

unsafe fn from_raw_descriptor(descriptor: RawDescriptor) -> Self

Safety

impl IntoRawDescriptor for Event

fn into_raw_descriptor(self) -> RawDescriptor

impl PartialEq for Event

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

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

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 Serialize for Event

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Event

impl StructuralPartialEq for Event