Struct Config 

pub struct Config { /* private fields */ }

Configuration for the termlink preprocessor.

All fields are private to allow future changes without breaking the API. Use the getter methods to access configuration values.

Implementations

impl Config

pub fn from_context(ctx: &PreprocessorContext) -> Result<Self, TermlinkError>

Creates configuration from the preprocessor context.

Unknown display-mode values fall back to the default with a log::warn!; invalid glob patterns under exclude-pages are dropped the same way. These are user-typo cases, not hard errors.

Errors

Returns TermlinkError::BadConfig if [preprocessor.termlink] in book.toml fails to deserialize.

pub fn glossary_path(&self) -> &Path

Returns the path to the glossary file.

pub const fn link_first_only(&self) -> bool

Returns true if only the first occurrence of each term should be linked.

pub fn css_class(&self) -> &str

Returns the CSS class to apply to glossary term links.

pub const fn case_sensitive(&self) -> bool

Returns true if term matching should be case-sensitive.

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

Checks if the given path is the glossary file.

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

Checks if the given path should be excluded from term linking.

pub fn aliases(&self, term_name: &str) -> Option<&Vec<String>>

Returns aliases for a term name (if configured).

pub fn split_pattern(&self) -> Option<&str>

Returns the split delimiter for glossary definitions, if configured.

pub const fn display_mode(&self) -> DisplayMode

Returns how linked terms should be rendered.

pub const fn process_glossary(&self) -> bool

Returns true if the glossary page itself should be processed.

When true, term usages in the glossary page’s prose and inside other terms’ definitions are linkified (with same-page #anchor hrefs), but the definition-list titles are left untouched so a term never self-links.

pub fn all_aliases(&self) -> impl Iterator<Item = (&String, &Vec<String>)>

Returns an iterator over every configured alias (for conflict detection).

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.