Struct lazycell::LazyCell

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

A lazily filled Cell, with mutable contents.

A LazyCell is completely frozen once filled, unless you have &mut access to it, in which case LazyCell::borrow_mut may be used to mutate the contents.

Implementations

impl<T> LazyCell<T>

pub fn new() -> LazyCell<T>

Creates a new, empty, LazyCell.

pub fn fill(&self, value: T) -> Result<(), T>

Put a value into this cell.

This function will return Err(value) if the cell is already full.

pub fn replace(&mut self, value: T) -> Option<T>

Put a value into this cell.

Note that this function is infallible but requires &mut self. By requiring &mut self we’re guaranteed that no active borrows to this cell can exist so we can always fill in the value. This may not always be usable, however, as &mut self may not be possible to borrow.

Return value

This function returns the previous value, if any.

pub fn filled(&self) -> bool

Test whether this cell has been previously filled.

pub fn borrow(&self) -> Option<&T>

Borrows the contents of this lazy cell for the duration of the cell itself.

This function will return Some if the cell has been previously initialized, and None if it has not yet been initialized.

pub fn borrow_mut(&mut self) -> Option<&mut T>

Borrows the contents of this lazy cell mutably for the duration of the cell itself.

This function will return Some if the cell has been previously initialized, and None if it has not yet been initialized.

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

Borrows the contents of this lazy cell for the duration of the cell itself.

If the cell has not yet been filled, the cell is first filled using the function provided.

Panics

Panics if the cell becomes filled as a side effect of f.

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

Borrows the contents of this LazyCell mutably for the duration of the cell itself.

If the cell has not yet been filled, the cell is first filled using the function provided.

Panics

Panics if the cell becomes filled as a side effect of f.

pub fn try_borrow_with<E, F>(&self, f: F) -> Result<&T, E> where
    F: FnOnce() -> Result<T, E>, 

Same as borrow_with, but allows the initializing function to fail.

Panics

Panics if the cell becomes filled as a side effect of f.

pub fn try_borrow_mut_with<E, F>(&mut self, f: F) -> Result<&mut T, E> where
    F: FnOnce() -> Result<T, E>, 

Same as borrow_mut_with, but allows the initializing function to fail.

Panics

Panics if the cell becomes filled as a side effect of f.

pub fn into_inner(self) -> Option<T>

Consumes this LazyCell, returning the underlying value.

impl<T: Copy> LazyCell<T>

pub fn get(&self) -> Option<T>

Returns a copy of the contents of the lazy cell.

This function will return Some if the cell has been previously initialized, and None if it has not yet been initialized.

Trait Implementations

impl<T: Clone> Clone for LazyCell<T>

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

Create a clone of this LazyCell

If self has not been initialized, returns an uninitialized LazyCell otherwise returns a LazyCell already initialized with a clone of the contents of self.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LazyCell<T>

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

Formats the value using the given formatter.

impl<T> Default for LazyCell<T>

fn default() -> Self

Returns the “default value” for a type.