Struct Control 

pub struct Control<T, U>
where
    T: 'static,
{ /* private fields */ }

Controls the collection and accumulation of thread-local variables linked to this object.

T is the type of the values sent on the channel to this object and U is the type of the accumulated value. The thread-locals must be of type Holder<T>.

Implementations

impl<T, U> Control<T, U>

pub fn new( tl: &'static LocalKey<Holder<T>>, acc_base: U, op: impl Fn(T, &mut U, ThreadId) + 'static + Send + Sync, ) -> Self

Instantiates a Control object.

• tl - reference to thread-local static.
• acc_base - initial value for accumulation.
• op - operation that combines data from thread-locals with accumulated value.

pub fn acc(&self) -> impl Deref<Target = U> + '_

Returns a guard object that dereferences to self’s accumulated value. A lock is held during the guard’s lifetime.

Panics

If self’s mutex is poisoned.

pub fn with_acc<V>(&self, f: impl FnOnce(&U) -> V) -> V

Provides access to self’s accumulated value.

Panics

If self’s mutex is poisoned.

pub fn clone_acc(&self) -> U

where U: Clone,

Returns a clone of self’s accumulated value.

Panics

If self’s mutex is poisoned.

pub fn take_acc(&self, replacement: U) -> U

Returns self’s accumulated value, using a value of the same type to replace the existing accumulated value.

Panics

If self’s mutex is poisoned.

pub fn start_receiving_tls(&self) -> Result<(), MultipleReceiverThreadsError>

where T: 'static + Send, U: 'static + Send,

Spawns a background thread to receive thread-local values and aggregate them with this object’s accumulated value. May be called repeatedly, provided that there are intervening calls to Self::stop_receiving_tls or Self::drain_tls.

Errors

Returns an error if there is already an active background receiver thread.

Panics

If self’s mutex is poisoned.

pub fn stop_receiving_tls(&self)

Signals the background receiving thread to terminate itself.

pub fn drain_tls(&self)

Receives all pending messages in channel and aggregates the corresponding values, terminating the background thread if it exists. May be called repeatedly, even before participating theads have terminated.

Panics

If self’s mutex is poisoned.

pub fn send_data(&self, data: T)

Sends data from the thread where it is called to be accumulated by the Control instance;

Trait Implementations

impl<T, U> Clone for Control<T, U>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.