Struct Container 

pub struct Container<T, Manager> { /* private fields */ }

A basic owned container allowing managed access to some underlying file.

Implementations

impl<T, Manager> Container<T, Manager>

pub const fn new(value: T, manager: Manager) -> Self

Create a new Container from the value and manager directly.

pub fn into_value(self) -> T

Extract the contained state.

pub fn into_manager(self) -> Manager

Extract the container manager.

pub const fn manager(&self) -> &Manager

Gets a reference to the contained file manager.

It is inadvisable to manipulate the manager manually.

pub const fn get(&self) -> &T

Gets a reference to the contained value.

You may also operate on the container directly with Deref instead.

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the contained value.

You may also operate on the container directly with DerefMut instead.

impl<T, Format, Lock, Mode> Container<T, FileManager<Format, Lock, Mode>>

where Format: FileFormat<T>, Lock: FileLock, Mode: FileMode,

pub fn open<P: AsRef<Path>>( path: P, format: Format, ) -> Result<Self, Error<Format::FormatError>>

where Mode: Reading,

Opens a new Container, returning an error if the file at the given path does not exist.

pub fn create_overwrite<P: AsRef<Path>>( path: P, format: Format, value: T, ) -> Result<Self, Error<Format::FormatError>>

Opens a new Container, creating a file at the given path if it does not exist, and overwriting its contents if it does.

pub fn create_or<P: AsRef<Path>>( path: P, format: Format, value: T, ) -> Result<Self, Error<Format::FormatError>>

Opens a new Container, writing the given value to the file if it does not exist.

pub fn create_or_else<P: AsRef<Path>, C>( path: P, format: Format, closure: C, ) -> Result<Self, Error<Format::FormatError>>

where C: FnOnce() -> T,

Opens a new Container, writing the result of the given closure to the file if it does not exist.

pub fn create_or_default<P: AsRef<Path>>( path: P, format: Format, ) -> Result<Self, Error<Format::FormatError>>

where T: Default,

Opens a new Container, writing the default value of T to the file if it does not exist.

impl<T, Format, Lock, Mode> Container<T, FileManager<Format, Lock, Mode>>

where Format: FileFormat<T>,

pub fn refresh(&mut self) -> Result<T, Error<Format::FormatError>>

where Mode: Reading,

Reads a value from the managed file, replacing the current state in memory.

pub fn commit(&self) -> Result<(), Error<Format::FormatError>>

where Mode: Writing,

Writes the current in-memory state to the managed file.

pub fn overwrite(&mut self, value: T) -> Result<(), Error<Format::FormatError>>

where Mode: Writing,

Writes the given state to the managed file, replacing the in-memory state.

impl<T, Format, Lock, Mode> Container<T, FileManager<Format, Lock, Mode>>

where Lock: FileLock,

pub fn close(self) -> Result<T>

Unlocks and closes this Container, returning the contained state.

Trait Implementations

impl<T: Debug, Manager: Debug> Debug for Container<T, Manager>

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

Formats the value using the given formatter.

impl<T, Manager> Deref for Container<T, Manager>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, Manager> DerefMut for Container<T, Manager>

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

Mutably dereferences the value.

impl<T, Manager> From<Container<T, Manager>> for ContainerShared<T, Manager>

Available on crate feature shared only.

fn from(container: Container<T, Manager>) -> Self

Converts to this type from the input type.

impl<T, Manager> From<Container<T, Manager>> for ContainerSharedAsync<T, Manager>

Available on crate feature shared-async only.

fn from(container: Container<T, Manager>) -> Self

Converts to this type from the input type.