Struct MultiThreadedCallback 

pub struct MultiThreadedCallback<T>
where
    T: Debug,
{ /* private fields */ }

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, 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()
    }
}

Implementations

impl<T> MultiThreadedCallback<T>

where T: Debug + Send + Sync + 'static,

pub fn new() -> Self

Creates a new multithreaded callback.

pub fn new_with_capacity(capacity: usize) -> Self

Creates a new multithreaded callback with a specified capacity.

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

impl<T> Callback<T> for MultiThreadedCallback<T>

where T: Debug,

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.

impl<T> Clone for MultiThreadedCallback<T>

where T: Debug,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MultiThreadedCallback<T>

where T: Debug + Debug,

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

Formats the value using the given formatter.