Struct ReadSettings 

pub struct ReadSettings {
    pub relations: RelationSet,
    pub workspace_id: String,
    pub id_storage: IdStorage,
}

The settings a read of a workspace depends on — the whole of what traversal needs to be told about the workspace it is traversing.

Three fields out of the ten a full workspace is configured with, and the cut is not arbitrary: these are the only ones that change what a link resolves to. relations says which metadata fields are edges at all; workspace_id is what lets a foreign id:<ws>/<id> reference be recognized as pointing back here rather than away; id_storage says whether a document’s own frontmatter is a place an id can be found. The other seven — link style, reference style, embed format and style, fixity, history — govern how prov writes, and a reader that never writes has no use for any of them.

Fields

relations: RelationSet

The relation vocabulary: which metadata fields are links, and which one (if any) is the spanning relation the tree walk follows.

workspace_id: String

What this workspace calls itself — the qualifier a cross-workspace reference names it by. Empty means anonymous, so no id:<ws>/<id> reference can ever be recognized as pointing back here.

id_storage: IdStorage

Where a document’s stable id is persisted, and so where resolution may look for one.

Trait Implementations

impl Clone for ReadSettings

fn clone(&self) -> ReadSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadSettings

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

Formats the value using the given formatter.

impl Default for ReadSettings

fn default() -> Self

Returns the “default value” for a type.