event_handler

Struct EventHandle

Source 
pub struct EventHandle<TEventArgs> { /* private fields */ }
Expand description

A handle to a registration. When the handle is dropped, the registration is revoked.

Implementations§

Source§

impl<TEventArgs> EventHandle<TEventArgs>

Source

pub fn is_valid(&self) -> bool

Determines whether the registration is still valid.

Source

pub fn invoke(&self, args: TEventArgs) -> Result<(), EventInvocationError>
where TEventArgs: Clone,

Invokes the event with the specified arguments.

§Arguments
  • args - The event arguments to pass.

Trait Implementations§

Source§

impl<TEventArgs> Drop for EventHandle<TEventArgs>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<TEventArgs> Invoke<TEventArgs> for EventHandle<TEventArgs>
where TEventArgs: Clone,

Source§

fn invoke(&self, args: TEventArgs)

Auto Trait Implementations§

§

impl<TEventArgs> Freeze for EventHandle<TEventArgs>

§

impl<TEventArgs> RefUnwindSafe for EventHandle<TEventArgs>

§

impl<TEventArgs> Send for EventHandle<TEventArgs>
where TEventArgs: Send + Sync,

§

impl<TEventArgs> Sync for EventHandle<TEventArgs>
where TEventArgs: Send + Sync,

§

impl<TEventArgs> Unpin for EventHandle<TEventArgs>

§

impl<TEventArgs> UnwindSafe for EventHandle<TEventArgs>

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.