Struct MemVault 

pub struct MemVault { /* private fields */ }

An in-memory vault. Interior mutability, so it can be shared as Arc<dyn Vault> and still written to.

Implementations

impl MemVault

pub const DEFAULT_ROOT: &'static str = "/mbr-mem-vault"

The default namespace root. Deliberately a path no real repository would sit at, so a key that is accidentally opened as a file fails loudly instead of reading something.

pub fn new() -> Self

An empty vault (just the root directory).

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

An empty vault whose Vault::root is root.

pub fn with_file(self, path: &str, contents: impl AsRef<[u8]>) -> Self

Builder form of Self::insert_file.

pub fn with_dir(self, path: &str) -> Self

Builder form of Self::insert_dir.

pub fn insert_file(&self, path: &str, contents: impl AsRef<[u8]>)

Creates or replaces a file (and its ancestor directories).

Panics

When path is not a valid VaultPath.

pub fn insert_dir(&self, path: &str)

Creates a directory (and its ancestors).

Panics

When path is not a valid VaultPath.

pub fn set_availability(&self, path: &str, availability: Availability)

Marks a file as listed-but-not-downloaded (or back).

Panics

When there is no such file.

pub fn set_dir_availability(&self, path: &str, availability: Availability)

Marks a directory as one whose listing is not downloaded (or back): its parent lists it, stat finds it, but Vault::list_dir fails VaultError::NotDownloaded — an iCloud Drive folder on iOS that nothing has listed yet. Unlike a file’s, a directory’s listing does not arrive on Vault::request_download: the request is recorded and the test makes it arrive, as the provider would, some time later.

Panics

When there is no such directory.

pub fn set_modified(&self, path: &str, modified: SystemTime)

Sets a file’s modification time.

Panics

When there is no such file.

pub fn contents(&self, path: &str) -> Option<Vec<u8>>

A file’s current bytes, for assertions.

pub fn hold_downloads(&self, held: bool)

Whether a requested download stays pending (true) or completes at once (false, the default). Models a provider that is offline or slow.

pub fn download_requests(&self) -> Vec<VaultPath>

Every path passed to Vault::request_download so far, in order.

Trait Implementations

impl Debug for MemVault

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

Formats the value using the given formatter.

impl Default for MemVault

fn default() -> Self

Returns the “default value” for a type.

impl Vault for MemVault

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 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 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_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 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 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.

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.