Skip to main content

IdStorage

Enum IdStorage 

Source
pub enum IdStorage {
    Registry,
    Frontmatter,
    FrontmatterOnly,
}
Expand description

Where a document’s stable ID is persisted — the identity-storage axis (DESIGN §5). Orthogonal to when an ID is minted (prov’s Registration) and to how references are spelled; this is purely the ID’s home.

Variants§

§

Registry

Registry only (registry): IDs live solely in the registry document — authoritative, non-derivable, resolved by direct lookup. The cleanest documents (no id clutter), but identity does not travel with a file.

§

Frontmatter

Frontmatter + registry (both, the default): each document also carries its own ID in an id frontmatter field (a portable, self-describing shadow), and the registry is retained as a rebuildable cache + tombstone ledger. The ID travels with the file across copies and out-of-band moves.

§

FrontmatterOnly

Frontmatter only (frontmatter): the id field is the sole home; no registry document is written and resolution rebuilds the id→path map by scanning frontmatter. Maximally self-describing, but it forfeits tombstones (a deleted file takes its ID with it), so an ID can in principle be reminted.

Implementations§

Source§

impl IdStorage

Source

pub fn stamps_frontmatter(self) -> bool

Whether this mode writes the ID into each document’s id frontmatter.

Source

pub fn keeps_registry(self) -> bool

Whether this mode keeps a registry document (the authoritative store, or — under Frontmatter — a rebuildable cache).

Source

pub fn from_config_str(value: &str) -> Option<Self>

Parse the id_storage config spelling; unknown → None. both is the frontmatter+registry default; frontmatter is the registry-less mode.

Source

pub fn as_config_str(self) -> &'static str

The id_storage config spelling.

Trait Implementations§

Source§

impl Clone for IdStorage

Source§

fn clone(&self) -> IdStorage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for IdStorage

Source§

impl Debug for IdStorage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IdStorage

Source§

fn default() -> IdStorage

Returns the “default value” for a type. Read more
Source§

impl Eq for IdStorage

Source§

impl PartialEq for IdStorage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for IdStorage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.