Struct merk::owner::Owner

pub struct Owner<T> { /* fields omitted */ }

A container type which holds a value that may be temporarily owned by a consumer.

Implementations

impl<T> Owner<T>

pub fn new(value: T) -> Owner<T>

Creates a new Owner which holds the given value.

pub fn own<F: FnOnce(T) -> T>(&mut self, f: F)

Takes temporary ownership of the contained value by passing it to f. The function must return a value of the same type (the same value, or a new value to take its place).

Example

let mut owner = Owner::new(SomeType());
owner.own(|value| {
    value.method_which_requires_ownership();
    SomeType() // now give back a value of the same type
});

pub fn own_return<R, F>(&mut self, f: F) -> R where
    R: Sized,
    F: FnOnce(T) -> (T, R), 

Takes temporary ownership of the contained value by passing it to f. The function must return a value of the same type (the same value, or a new value to take its place).

Like own, but uses a tuple return type which allows specifying a value to return from the call to own_return for convenience.

Example

let mut owner = Owner::new(123);
let doubled = owner.own_return(|n| (n, n * 2));

pub fn into_inner(self) -> T

Sheds the Owner container and returns the value it contained.

Trait Implementations

impl<T> Deref for Owner<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Owner<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.