Struct LinkTargetPolicy 

pub struct LinkTargetPolicy { /* private fields */ }

Run-scoped document paths that filesystem-aware link rules should treat as present even when their content did not come from disk.

Implementations

impl LinkTargetPolicy

pub fn open_world<I, P>(paths: I) -> Self

where I: IntoIterator<Item = P>, P: AsRef<Path>,

Supplied documents override disk, while targets outside the supplied set continue to use normal filesystem resolution.

pub fn closed_world<I, P>(paths: I) -> Self

where I: IntoIterator<Item = P>, P: AsRef<Path>,

Only supplied documents are valid relative link targets.

pub fn with_declared_targets<I, P, F, D>( paths: I, files: F, directories: D, allow_disk_fallback: bool, ) -> Self

where I: IntoIterator<Item = P>, P: AsRef<Path>, F: IntoIterator<Item = PathBuf>, D: IntoIterator<Item = PathBuf>,

A supplied set that also holds paths declared to exist without being documents: files join the supplied paths, and directories (possibly empty ones) join the implied directories only, so a directory never answers for an extensionless link meant as a document.

pub fn declared_target_for(&self, path: &Path) -> Option<PathBuf>

The path the set resolves path to, when that answer is a declared target rather than a supplied document: a link there names a file or directory whose content the run does not have. Resolved as resolve_supplied resolves it, so a link written without a root follows the same precedence as one written with it.

pub fn contains(&self, path: &Path) -> bool

pub fn contains_with_markdown_extension(&self, path: &Path) -> bool

pub fn allow_disk_fallback(&self) -> bool

Trait Implementations

impl Clone for LinkTargetPolicy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkTargetPolicy

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

Formats the value using the given formatter.