Struct PackStore 

pub struct PackStore { /* private fields */ }

A TileStore over one append-only file.

Implementations

impl PackStore

pub fn open(path: impl Into<PathBuf>) -> Result<Self>

Opens the pack at path for writing, creating it when absent, and takes <path>.lock. A pack another writer holds is refused with io::ErrorKind::WouldBlock.

pub fn open_shared(path: impl Into<PathBuf>) -> Result<Self>

Opens the pack at path as one of several writers, creating it when absent. No lock is held between changes; each change waits up to SHARED_LOCK_WAIT for <path>.lock and fails with io::ErrorKind::WouldBlock after that.

pub fn open_shared_waiting( path: impl Into<PathBuf>, wait: Duration, ) -> Result<Self>

PackStore::open_shared with its own wait for the lock.

pub fn open_read(path: impl Into<PathBuf>) -> Result<Self>

Opens the pack at path for reading, without a lock. The pack must exist.

pub fn break_lock(path: impl AsRef<Path>) -> Result<bool>

Removes a lock a crashed writer left. The caller knows no writer is alive; nothing here checks.

pub fn path(&self) -> &Path

The pack file.

pub fn len(&self) -> Result<u64>

Length of the pack file, including any torn tail.

pub fn is_empty(&self) -> Result<bool>

Whether the pack holds no path.

pub fn live_bytes(&self) -> Result<u64>

Bytes the live records occupy, framing, magic and index included: the pack after a compaction is exactly this long.

pub fn compact(&self) -> Result<Compacted>

Rewrites the pack with one record per live path, in path order, and renames it over the old one. The tree and every proof are untouched: they are over entry bytes, and every live path keeps its bytes.

Trait Implementations

impl Drop for PackStore

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl TileStore for PackStore

fn get(&self, path: &str) -> Result<Option<Vec<u8>>>

The bytes at path, or nothing when there is no such file.

fn put(&self, path: &str, bytes: &[u8]) -> Result<()>

Writes bytes at path, whole or not at all, replacing what is there.

fn create_new(&self, path: &str, bytes: &[u8]) -> Result<bool>

Writes bytes at path only when nothing is there; false when something is.

fn delete(&self, path: &str) -> Result<bool>

Removes path; false when there was nothing to remove.

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

Moves from to to, replacing what is at to.

fn list(&self, prefix: &str) -> Result<Vec<String>>

Every file path under prefix (a directory path without a trailing slash, or the empty string for the whole store), sorted.

fn exists(&self, path: &str) -> Result<bool>

Whether anything is stored at path.