snapshot

Types

Snapshot

opaque </>

Immutable snapshot of one filesystem subtree at a single instant.

opaque because the only legitimate way to construct a snapshot is through entries that have already passed Entry’s validation. Snapshots are keyed on the canonical string rendering of each entry’s NormalizedPath so callers can lookup by either string or NormalizedPath without constructing a new opaque value.

pub opaque type Snapshot

Values

add_entry

</>

pub fn add_entry(
  snapshot snapshot: Snapshot,
  entry e: entry.Entry,
) -> Result(Snapshot, ast.FseventError)

Insert a single entry. Rejected if the path is already present.

empty_snapshot

</>

pub fn empty_snapshot() -> Snapshot

A snapshot containing no entries.

entries

</>

pub fn entries(snapshot snapshot: Snapshot) -> List(entry.Entry)

All entries the snapshot holds, sorted by canonical path so that the order is deterministic across the BEAM and JavaScript targets.

from_entries

</>

pub fn from_entries(
  entries entries: List(entry.Entry),
) -> Result(Snapshot, ast.FseventError)

Build a snapshot from a list of entries. Two entries with the same path is rejected as DuplicatePath. Entries with the same file_id but different paths are allowed (POSIX hard links).

is_empty

</>

pub fn is_empty(snapshot snapshot: Snapshot) -> Bool

True when the snapshot has no entries.

lookup

</>

pub fn lookup(
  snapshot snapshot: Snapshot,
  path path: path.NormalizedPath,
) -> option.Option(entry.Entry)

Look up the entry at path, if any.

snapshot_size

</>

pub fn snapshot_size(snapshot snapshot: Snapshot) -> Int

Number of entries in the snapshot.