Struct FileRefs 

pub struct FileRefs {
    pub roots: Vec<String>,
    pub formats: Vec<RefFormat>,
}

[file_refs] — how document ids are mentioned in code, for opys show <id> --refs and the post-renumber reference warning. This is about textual mentions of an id (e.g. FEAT-0123) in source files, distinct from the references relation maps between documents (see crate::refs).

Fields

roots: Vec<String>

Directories to scan, project-root relative. Defaults to the whole project (["."]). The inventory base, .git, target, node_modules, and hidden directories are always skipped.

formats: Vec<RefFormat>

The textual forms an id may take in code. When empty, a single canonical {id} word-boundary format is assumed (see FileRefs::effective_formats).

Implementations

impl FileRefs

pub fn effective_formats(&self) -> Vec<RefFormat>

The configured formats, or a single canonical {id} word-boundary format when none are configured (so the feature works without any config).

Trait Implementations

impl Clone for FileRefs

fn clone(&self) -> FileRefs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileRefs

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

Formats the value using the given formatter.

impl Default for FileRefs

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileRefs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.