Enum Documents 

pub enum Documents {
    Nowhere,
    In(PathBuf),
}

Where new documents are born.

Variants

Nowhere

Nowhere to put one: the platform names no documents directory, no home, and no working directory. A new document opens as a scratch session rather than the app guessing at somewhere to write.

In(PathBuf)

Implementations

impl Documents

pub fn platform() -> Self

The platform’s documents directory, falling back to the home directory and then to the working directory — a machine with no Documents folder still gets a document somewhere it can find it.

pub fn at(dir: impl Into<PathBuf>) -> Self

pub fn dir(&self) -> Option<&Path>

pub fn create( &self, draw: impl FnMut() -> u32, ) -> Result<Store<Any>, BirthFailure>

Create a container for a new document, under a name nothing here is using. A name already taken is not an error but a redraw: draw supplies the numbers, so a test can stage the collision it wants.

Errors

BirthFailure — which the caller turns into a scratch session and a notice, never a refusal to start.

Trait Implementations

impl Clone for Documents

fn clone(&self) -> Documents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documents

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

Formats the value using the given formatter.

impl Default for Documents

fn default() -> Documents

Returns the “default value” for a type.

impl PartialEq for Documents

fn eq(&self, other: &Documents) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Documents

impl StructuralPartialEq for Documents