Struct buttplug::util::future::ButtplugFutureState

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

Struct used for facilitating resolving futures across contexts.

Since ButtplugFuture is Pinned, we can’t just go passing it around tasks or threads. This struct is therefore used to get replies from other contexts while letting the future stay pinned. It holds the reply to the future, as well as a Waker for waking up the future when the reply is set.

Implementations

impl<T> ButtplugFutureState<T>

pub fn set_reply(&mut self, reply: T)

Sets the response for the future, firing the waker.

When a response is received from whatever we’re waiting on, this function takes the response, updates the state struct, and calls Waker::wake so that the corresponding future can finish.

Panics

If the reply is set twice, the library will panic. We have no way of resolving two replies to the same future, so this is considered a catastrophic error.

Trait Implementations

impl<T: Clone> Clone for ButtplugFutureState<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ButtplugFutureState<T>

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

Formats the value using the given formatter.

impl<T> Default for ButtplugFutureState<T>

fn default() -> Self

Returns the “default value” for a type.