Skip to main content

WorkspaceLayout

Struct WorkspaceLayout 

Source
pub struct WorkspaceLayout { /* private fields */ }
Expand description

Where a workspace keeps its files.

Pure path arithmetic and one directory listing — it opens nothing and locks nothing. A caller that only needs “which file is work?” (the CLI resolving --db work) wants this and not the handle pool.

Implementations§

Source§

impl WorkspaceLayout

Source

pub fn new(root: impl Into<PathBuf>) -> Self

A layout rooted at root. Creates nothing; the directories appear when a database is first written.

Source

pub fn root(&self) -> &Path

The workspace root.

Source

pub fn db_dir(&self) -> PathBuf

The directory holding the databases, <root>/db.

Source

pub fn path_of(&self, name: &DbName) -> PathBuf

The file backing name, <root>/db/<name>.plugmem.

A join of validated components, so the result is always inside WorkspaceLayout::db_dir.

Source

pub fn registry_path(&self) -> PathBuf

The registry’s file, <root>/registry.plugmem. It sits in the root rather than beside the databases, so no name can collide with it.

Source

pub fn exists(&self, name: &DbName) -> bool

Whether name is a database on disk.

Asks the storage layer rather than stat-ing the path: a database that has been written to but not yet checkpointed has no file at its base path, and treating it as absent would mean creating over it.

Source

pub fn list(&self) -> Result<Vec<DbName>, WorkspaceError>

Every database in the workspace, sorted by name.

Reads the directory — the filesystem is the truth, the registry is only an index over it. A missing db/ is an empty workspace, not an error. Files whose name is not a database’s are skipped here and reported by the registry’s verify, which is where a person is asking about consistency rather than about what they can open.

One database is several files (chat-42.plugmem, .journal, .lock, .snap.N), so the listing folds them back to one name each: a name cannot contain a dot, so everything up to the first dot is the candidate, and the storage layer confirms whether a database is really there.

§Errors

WorkspaceError::Io if the directory exists but cannot be read.

Trait Implementations§

Source§

impl Clone for WorkspaceLayout

Source§

fn clone(&self) -> WorkspaceLayout

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WorkspaceLayout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for WorkspaceLayout

Source§

impl PartialEq for WorkspaceLayout

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WorkspaceLayout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.