Struct buttplug::util::future::ButtplugFutureStateShared

pub struct ButtplugFutureStateShared<T> { /* private fields */ }

Shared ButtplugFutureState type.

ButtplugFutureState is made to be shared across tasks, and we’ll never know if those tasks are running on single or multithreaded executors.

Panics and notes on setting replies

The lock for a ButtplugFutureState should only ever be taken when the reply is being set (which the set_reply method does internally), and there should never be a point where the reply is set twice (See the panic documentation for ButtplugFutureState). In order to make sure we never block, we always lock using try_lock with .expect(). If try_lock fails, this means we’re already in a double reply situation, and therefore we’ll panic on the .expect(). Any panic from this should be considered a library error and reported as a bug.

Implementations

impl<T> ButtplugFutureStateShared<T>

pub fn new(state: ButtplugFutureState<T>) -> Self

pub fn set_reply(&self, reply: T)

Locks immediately and sets the reply for the internal waker, or panics if lock is held.

See ButtplugFutureStateShared struct documentation for more info on locking.

Trait Implementations

impl<T> Clone for ButtplugFutureStateShared<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ButtplugFutureStateShared<T>

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

Formats the value using the given formatter.

impl<T> Default for ButtplugFutureStateShared<T>

fn default() -> Self

Returns the “default value” for a type.