Struct Layout 

pub struct Layout { /* private fields */ }

Absolute paths of everything a database keeps on disk, by role — the port of the TS Layout, narrowed to the roles this engine actually writes (format 2 keeps no per-table schema files, and its write queue stages in memory rather than in a pending/ directory).

Implementations

impl Layout

pub fn new(root: &Path, kind: LayoutKind, metadata_file: &str) -> Layout

pub fn kind(&self) -> LayoutKind

pub fn root(&self) -> &Path

pub fn metadata_file(&self) -> &str

Name of the metadata document in Layout::root — the value OpenOptions’ metadataFile/manifest takes.

pub fn metadata_path(&self) -> &Path

Absolute path of the metadata document: Layout::root and Layout::metadata_file joined.

pub fn tables(&self) -> &Path

Directory the table logs live in. A partitioned table gets a <table>/ subdirectory of this one; Table::open derives that from the log path it is handed, so nothing else here has to.

pub fn indexes(&self) -> &Path

Directory the <table>.idx snapshots live in.

pub fn runtime(&self) -> &Path

Directory the writer lock and the unit-of-work journal live in.

pub fn log_path(&self, table: &str) -> PathBuf

pub fn index_path(&self, table: &str) -> PathBuf

pub fn lock_path(&self) -> PathBuf

pub fn journal_path(&self) -> PathBuf

pub fn directories(&self) -> Vec<PathBuf>

Directories a writable open has to create before anything touches them. Under the flat layout that is the database directory and nothing else, which is what makes an open with no layout options do exactly what it did before layouts existed.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Eq for Layout

impl PartialEq for Layout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Layout