MultiThreadedCallback

Struct MultiThreadedCallback 

Source
pub struct MultiThreadedCallback<T>
where T: Debug + Send + Sync,
{ /* private fields */ }
Expand description

A multithreaded callback holder.

This callback holder will invoke the given events on a separate thread, thus unblocking the caller thread for other tasks.

§Example

use fx_callback::{Callback, MultiThreadedCallback, Subscriber, Subscription};

/// The events of the struct that informs subscribers about changes to the data within the struct.
#[derive(Debug, Clone, PartialEq)]
enum MyEvent {
    Foo,
}

/// The struct to which an interested subscriber can subscribe to.
#[derive(Debug)]
struct Example {
    callbacks: MultiThreadedCallback<MyEvent>,
}

impl Example {
    fn invoke_event(&self) {
        self.callbacks.invoke(MyEvent::Foo);
    }
}

impl Callback<MyEvent> for Example {
    fn subscribe(&self) -> Subscription<MyEvent> {
        self.callbacks.subscribe()
    }

    fn subscribe_with(&self, subscriber: Subscriber<MyEvent>) {
        self.callbacks.subscribe_with(subscriber)
    }
}

Implementations§

Source§

impl<T> MultiThreadedCallback<T>
where T: Debug + Send + Sync + 'static,

Source

pub fn new() -> Self

Creates a new multithreaded callback.

Source

pub fn invoke(&self, value: T)

Invoke the currently registered callbacks and inform them of the given value.

§Arguments
  • value - The value to invoke the callbacks with.

Trait Implementations§

Source§

impl<T> Callback<T> for MultiThreadedCallback<T>
where T: Debug + Send + Sync,

Source§

fn subscribe(&self) -> Subscription<T>

Subscribe to the interested event. This creates a new Subscription that will be invoked with a shared instance of the event when the interested event occurs. Read more
Source§

fn subscribe_with(&self, subscriber: Subscriber<T>)

Subscribe to the interested event with a Subscriber. This creates an underlying new subscription which will be invoked with the given subscriber when the interested event occurs. Read more
Source§

impl<T> Clone for MultiThreadedCallback<T>
where T: Debug + Send + Sync + Clone,

Source§

fn clone(&self) -> MultiThreadedCallback<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for MultiThreadedCallback<T>
where T: Debug + Send + Sync + Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V