Struct LocalVault 

pub struct LocalVault { /* private fields */ }

A repository directory on the local filesystem.

Implementations

impl LocalVault

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

A vault rooted at root, canonicalized when it exists.

Canonical because every path this vault produces is relativized against it: canonicalize on a child returns a canonical path, and on macOS a temp dir (/var/…) or on Windows any path (\\?\C:\…) differs from its canonical spelling, which would make every child look like it is outside the root. Falls back to the path as given when it cannot be canonicalized (it does not exist yet); every operation then fails with the real error rather than here.

pub fn with_availability_probe(self, probe: AvailabilityProbe) -> Self

Classifies files with probe (see AvailabilityProbe) in every Entry this vault produces and in Vault::availability.

pub fn with_mounts(root: impl Into<PathBuf>, policy: MountPolicy) -> Self

A vault rooted at root (canonicalized, as Self::new) that serves links out of it as read-only mounts under policy — see [super::mount]. This is what the repository and its external static overlay are built with (crate::repo::Repo::init).

pub fn native(&self, path: &VaultPath) -> PathBuf

The native path for path.

Trait Implementations

impl Clone for LocalVault

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 LocalVault

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

Formats the value using the given formatter.

impl Vault for LocalVault

fn root(&self) -> &Path

The namespace Vault::keys live under. For LocalVault, the canonical repository root; for any other vault, an identifier that is never opened.

fn stat(&self, path: &VaultPath) -> Result<Option<Entry>, VaultError>

The entry at path (following symlinks), or None when nothing is there.

fn list_dir(&self, dir: &VaultPath) -> Result<Vec<Entry>, VaultError>

The immediate children of directory dir, in no particular order.

fn canonicalize(&self, path: &VaultPath) -> Result<VaultPath, VaultError>

Resolves symlinks in path and returns where it really is inside the vault.

fn read(&self, path: &VaultPath) -> Result<Vec<u8>, VaultError>

The whole file.

fn read_prefix( &self, path: &VaultPath, max_len: usize, ) -> Result<Vec<u8>, VaultError>

At most the first max_len bytes (frontmatter extraction reads 8 KB).

fn read_range( &self, path: &VaultPath, offset: u64, len: usize, ) -> Result<Vec<u8>, VaultError>

At most len bytes starting at byte offset: fewer at the end of the file, none past it. The streaming and Range path for files a vault has no Vault::local_path for (mbr_server serves those in chunks).

fn availability(&self, path: &VaultPath) -> Availability

Whether the file at path is on this device, decided without reading it — the check a server makes before handing a file to a reader that would block on (or fail half-way through) a not-downloaded one.

fn write_atomic(&self, path: &VaultPath, bytes: &[u8]) -> Result<(), VaultError>

Replaces (or creates) path with bytes atomically: readers see the old content or the new, never a mix, and a failure leaves the old file. The parent directory must exist. An existing file’s permissions are kept.

fn create_dir_all(&self, path: &VaultPath) -> Result<(), VaultError>

Creates path and any missing ancestors as directories.

fn remove_file(&self, path: &VaultPath) -> Result<(), VaultError>

Removes the file at path.

fn rename(&self, from: &VaultPath, to: &VaultPath) -> Result<(), VaultError>

Renames from to to, replacing a file at to.

fn local_path(&self, path: &VaultPath) -> Option<PathBuf>

A real filesystem path for path, when one exists — the fast path for consumers that need one (ServeFile, grep’s search_path, ffmpeg, pdfium, mmap). None means “read it through the vault”.

fn is_read_only(&self, path: &VaultPath) -> bool

Whether path lies in a read-only part of the vault — a symlink mount’s location or anything under it. Lexical: callers pass resolved (canonical) paths, and the vault’s own write methods re-check the canonical form. false for vaults without mounts.

fn mounts(&self) -> Vec<Mount>

The symlink mounts accepted so far (see Mount). They are discovered as paths through them are first resolved, so the list grows during the first scan. Empty for vaults without mounts.

fn request_download(&self, _paths: &[VaultPath])

Asks for not-downloaded files to be fetched. Returns immediately; completion shows up as the files becoming readable. A no-op for vaults whose files are always local.

fn read_to_string(&self, path: &VaultPath) -> Result<String, VaultError>

The whole file as UTF-8. Invalid UTF-8 is an VaultError::Io with ErrorKind::InvalidData, as std::fs::read_to_string reports it.

fn key(&self, path: &VaultPath) -> PathBuf

The index key for path: path under Vault::root.

fn vault_path(&self, key: &Path) -> Result<VaultPath, VaultError>

The vault path for an index key — the inverse of Vault::key. Lexical: it does not resolve symlinks.

fn is_file(&self, path: &VaultPath) -> bool

Whether path is an existing file. Errors read as false, as Path::is_file does.

fn is_dir(&self, path: &VaultPath) -> bool

Whether path is an existing directory. Errors read as false.