Struct EntryDirectory 

pub struct EntryDirectory { /* private fields */ }

Sirno Lake entry directory.

Invariant: root is the directory containing Sirno Lake Markdown entry files.

Implementations

impl EntryDirectory

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

Construct an entry directory rooted at root.

pub fn root(&self) -> &Path

Directory containing Sirno Lake Markdown entry files.

pub fn entry_artifact_root_path(&self, id: &EntryAddress) -> PathBuf

Sirno Lake artifact directory path for one entry address.

pub fn entry_artifact_path( &self, id: &EntryAddress, path: &EntryArtifactPath, ) -> PathBuf

Sirno Lake artifact file path for one entry-owned artifact.

pub fn entry_exists( &self, id: &EntryAddress, ) -> Result<bool, EntryDirectoryError>

Returns true when this directory contains the file for id.

pub fn read_entry_source( &self, id: &EntryAddress, ) -> Result<String, EntryDirectoryError>

Read one Sirno Lake Markdown entry file source by path.

pub fn read_entries_with_registry( &self, meta: &MetaRegistry, ignore: impl IntoIterator<Item = PathBuf>, ) -> Result<Vec<Entry>, EntryDirectoryError>

Read every projected Markdown entry through an external metadata registry.

This is used by mist projections. The projection is an interface over selected entries, while the reservoir supplies the lake-wide metadata vocabulary.

pub fn read_entry( &self, id: &EntryAddress, ) -> Result<Entry, EntryDirectoryError>

Read one Sirno Lake Markdown entry file by path.

pub fn replace_entry_source( &self, id: &EntryAddress, source: &str, ) -> Result<PathBuf, EntryDirectoryError>

Replace one existing Sirno Lake Markdown entry source.

The entry address controls the target path. Frozen entries cannot be changed through this low-level replacement.

pub fn write_entry_source( &self, id: &EntryAddress, source: &str, ) -> Result<PathBuf, EntryDirectoryError>

Write one Sirno Lake Markdown entry source, creating it when absent.

Existing frozen entries cannot be changed.

pub fn read_entry_artifacts( &self, id: &EntryAddress, ) -> Result<Vec<EntryArtifact>, EntryDirectoryError>

Read lake-owned artifacts for one entry address.

pub fn add_entry_artifact( &self, id: &EntryAddress, source: &Path, artifact_path: &EntryArtifactPath, ) -> Result<PathBuf, EntryDirectoryError>

Copy one filesystem file into an entry’s artifact tree.

pub fn rename_entry_artifact( &self, id: &EntryAddress, old_path: &EntryArtifactPath, new_path: &EntryArtifactPath, ) -> Result<PathBuf, EntryDirectoryError>

Rename one entry-owned artifact path.

pub fn remove_entry_artifact( &self, id: &EntryAddress, artifact_path: &EntryArtifactPath, ) -> Result<PathBuf, EntryDirectoryError>

Remove one entry-owned artifact file.

pub fn check( &self, mode: CheckMode, ) -> Result<EntryDirectoryReport, EntryDirectoryError>

Check this Sirno Lake entry directory.

pub fn check_with_settings( &self, mode: CheckMode, settings: &EntryDirectoryCheckSettings, ) -> Result<EntryDirectoryReport, EntryDirectoryError>

Check this Sirno Lake entry directory with explicit settings.

pub fn init(&self) -> Result<Vec<PathBuf>, EntryDirectoryError>

Initialize this directory with ordinary seed entries.

Existing entry files are never overwritten.

pub fn create_entry( &self, entry: &Entry, ) -> Result<PathBuf, EntryDirectoryError>

Create one Sirno Lake Markdown entry file in this directory.

The entry directory is created if needed. Existing entry files are never overwritten.

pub fn freeze_entry( &self, id: &EntryAddress, ) -> Result<PathBuf, EntryDirectoryError>

Mark one Sirno Lake Markdown entry as frozen and read-only.

The entry metadata gains the canonical reviewed frozen reason. Local file protection is applied after the reason is written.

pub fn melt_entry( &self, id: &EntryAddress, ) -> Result<PathBuf, EntryDirectoryError>

Mark one Sirno Lake Markdown entry as melted and writable.

The canonical reviewed frozen reason is removed from entry metadata. The file is left writable so normal editing can resume.

pub fn rename_entry( &self, old_id: &EntryAddress, new_id: &EntryAddress, settings: &EntryDirectoryCheckSettings, ) -> Result<EntryRenameReport, EntryDirectoryError>

Rename one entry address and every structural link reference that names it.

Existing generated-link regions are refreshed after metadata changes. Prose outside generated-link regions remains user-owned.

pub fn write( &self, entries: &[Entry], policy: EntryDirectoryWritePolicy, ) -> Result<Vec<PathBuf>, EntryDirectoryError>

Write a complete Sirno Lake entry directory.

The write policy controls how existing target contents are handled.

pub fn write_with_artifacts( &self, entries: &[Entry], artifacts: &[EntryArtifact], policy: EntryDirectoryWritePolicy, ) -> Result<Vec<PathBuf>, EntryDirectoryError>

Write a complete Sirno Lake entry directory with lake-owned artifacts.

The write policy controls how existing target contents are handled.

pub fn replace_glacier( &self, domain: &EntryAtom, entries: &[Entry], artifacts: &[EntryArtifact], settings: &EntryDirectoryCheckSettings, ) -> Result<GlacierReport, EntryDirectoryError>

Replace one glacier.

Existing files under the glacier domain must already be managed by crystallization.

pub fn ensure_glacier_replaceable( &self, domain: &EntryAtom, settings: &EntryDirectoryCheckSettings, ) -> Result<(), EntryDirectoryError>

Require all existing paths in a glacier domain to be crystallization-managed.

pub fn set_readonly( &self, settings: &EntryDirectoryCheckSettings, ) -> Result<(), EntryDirectoryError>

Mark this directory as read-only.

Sirno removes ordinary write permission from managed paths. It also applies the best-effort immutable guard used by frozen entries. Ignored paths are left untouched.

pub fn set_writable( &self, settings: &EntryDirectoryCheckSettings, ) -> Result<(), EntryDirectoryError>

Mark this directory as writable.

Sirno clears its best-effort immutable guard before restoring ordinary write permission. Ignored paths are left untouched.

pub fn clear_local_protection( &self, settings: &EntryDirectoryCheckSettings, dry_run: bool, ) -> Result<EntryProtectionReport, EntryDirectoryError>

Clear every Sirno local protection guard in this directory.

Frozen metadata and checkout lock state remain unchanged. Ignored paths are left untouched.

pub fn fix_local_protection( &self, settings: &EntryDirectoryCheckSettings, protect_checkout: bool, dry_run: bool, ) -> Result<EntryProtectionReport, EntryDirectoryError>

Reapply local protection from frozen metadata and checkout state.

protect_checkout selects the whole lake for an immutable managed checkout. Otherwise, only entries carrying frozen reasons and their artifact trees are protected. Ignored paths are left untouched.

pub fn add_readonly_checkout_warnings( &self, paths: &[PathBuf], ) -> Result<(), EntryDirectoryError>

Add read-only checkout warnings to rendered entry files.

The warning is written as a Markdown blockquote at the beginning of the body.

pub fn generate_links( &self, settings: &StructuralSettings, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Generate Markdown link footers for this Sirno Lake entry directory.

The directory must pass review-mode checks before any file is written.

pub fn check_generated_links( &self, settings: &StructuralSettings, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Check which generated Markdown link footers would change in this directory.

No file is written.

pub fn generate_links_with_ignored_paths( &self, settings: &StructuralSettings, ignore: impl IntoIterator<Item = PathBuf>, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Generate Markdown link footers for this directory with ignored paths.

Ignored paths are relative to the entry directory root.

pub fn generate_links_with_check_settings( &self, settings: &EntryDirectoryCheckSettings, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Generate Markdown link footers using directory check settings.

pub fn generate_links_for_crystallization( &self, settings: &EntryDirectoryCheckSettings, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Generate Markdown link footers while allowing managed glacier entries to change.

pub fn check_generated_links_with_ignored_paths( &self, settings: &StructuralSettings, ignore: impl IntoIterator<Item = PathBuf>, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Check which generated Markdown link footers would change with ignored paths.

Ignored paths are relative to the entry directory root. No file is written.

pub fn check_generated_links_with_check_settings( &self, settings: &EntryDirectoryCheckSettings, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Check generated Markdown link footers using directory check settings.

No file is written.

pub fn delete_generated_links( &self, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Delete generated Markdown link footers from this Sirno Lake entry directory.

The directory must parse cleanly before any file is written.

pub fn delete_generated_links_with_ignored_paths( &self, ignore: impl IntoIterator<Item = PathBuf>, ) -> Result<GenLinkDirectoryReport, EntryDirectoryError>

Delete generated Markdown link footers with ignored paths.

Ignored paths are relative to the entry directory root.

pub fn entry_file_path(&self, id: &EntryAddress) -> PathBuf

Trait Implementations

impl Clone for EntryDirectory

fn clone(&self) -> EntryDirectory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntryDirectory

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

Formats the value using the given formatter.

impl Eq for EntryDirectory

impl PartialEq for EntryDirectory

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EntryDirectory