Struct tokio_lock::Lock

pub struct Lock<T, E> where
    E: StdError + From<Error> + Send + 'static,  { /* fields omitted */ }

This structure "locks" an object to be accessed from a single Tokio task.

Methods

impl<T, E> Lock<T, E> where
    E: StdError + From<Error> + Send + 'static, 

pub fn new() -> Self

Create new instance of a Lock.

pub fn manage(
    &mut self,
    value: T
) -> impl Future<Item = (), Error = Error>

Consume value and return a Future for managing it.

pub fn get<CB, F, I>(
    &mut self,
    cb: CB
) -> impl Future<Item = I, Error = E> where
    CB: FnMut(&T) -> F + Send + 'static,
    F: Future<Item = I, Error = E> + Send + 'static,
    I: Send + 'static, 

Get the managed object and invoke cb with a reference to it.

pub fn get_mut<I, CB, F>(
    &mut self,
    cb: CB
) -> impl Future<Item = I, Error = E> where
    CB: FnMut(&mut T) -> F + Send + 'static,
    F: Future<Item = I, Error = E> + Send + 'static,
    I: Send + 'static, 

Get the managed object and invoke cb with a mutable reference to it.

pub fn stop(&mut self)

Stop managing the object.

Trait Implementations

impl<T, E> Default for Lock<T, E> where
    E: StdError + From<Error> + Send + 'static, 

fn default() -> Self

Returns the "default value" for a type.

impl<T, E> Clone for Lock<T, E> where
    E: StdError + From<Error> + Send + 'static, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.