Struct Event

pub struct Event<T: Interface> { /* private fields */ }
Expand description

A type that you can use to declare and implement an event of a specified delegate type.

The implementation is thread-safe and designed to avoid contention between events being raised and delegates being added or removed.

Implementations§

§

impl<T: Interface> Event<T>

pub const fn new() -> Self

Creates a new, empty Event<T>.

pub fn add(&self, delegate: &T) -> Result<i64>

Registers a delegate with the event object.

pub fn remove(&self, token: i64)

Revokes a delegate’s registration from the event object.

pub fn clear(&self)

Clears the event, removing all delegates.

pub fn call<F: FnMut(&T) -> Result<()>>(&self, callback: F)

Invokes all of the event object’s registered delegates with the provided callback.

Trait Implementations§

§

impl<T: Interface> Default for Event<T>

§

fn default() -> Self

Returns the “default value” for a type. Read more
§

impl<T: Interface> Send for Event<T>

§

impl<T: Interface> Sync for Event<T>

Auto Trait Implementations§

§

impl<T> !Freeze for Event<T>

§

impl<T> RefUnwindSafe for Event<T>

§

impl<T> Unpin for Event<T>

§

impl<T> UnwindSafe for Event<T>

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> 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, 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.