Struct Event 

pub struct Event { /* private fields */ }

An Event is an Type that can send Signals to other parts of the code. They can be automatically or manually reset. With manually reset events all waiting threads are worken up, but with automatically reset Event only one wakes up and can do the work.

An Automatically reset Event can trigger multiple times in a row and wake a whole lot of threads up

Implementations

impl Event

pub fn signal(&self) -> Result<bool, Error>

Triggers the event and signals all Threads waiting on it. The Event has to be reset after callling the function It returns if the signal was previously triggered

pub fn reset(&self) -> Result<bool, Error>

Event::reset resets manual Events. It does nothing in Automatic Events

pub fn pulse(&self) -> Result<bool, Error>

Sets and resets the Event in an Atomic Operation. Simultanous Reads will show the Event as unsignaled

pub fn status(&self) -> Result<EventStatus, Error>

Returns the Status at the moment of the Query.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl From<Event> for EventSources

fn from(val: Event) -> Self

Converts to this type from the input type.

impl Hash for Event

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

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

fn delete(self) -> Result<(), Error>

deletes the event from the program. All instances of this event are now invalid

type Status = EventStatus

The Status represents the status of the object at the time the read method call returned. It must not be shared across threads.

fn read(&self) -> Result<Self::Status, Error>

Reads the status of the object

impl PartialEq for Event

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

impl Eq for Event

impl Send for Event

impl StructuralPartialEq for Event

impl Sync for Event