Struct GlossaryEdit 

pub struct GlossaryEdit {
    document: GlossaryAndReferences,
    created: Vec<CreatedIds>,
    renames: Vec<(String, String)>,
    reported_keys: BTreeSet<String>,
    reported_terms: BTreeSet<String>,
}

The edited document, before its effects on the pages are worked out.

Fields

document: GlossaryAndReferences

created: Vec<CreatedIds>

renames: Vec<(String, String)>

reported_keys: BTreeSet<String>

reported_terms: BTreeSet<String>

Implementations

impl GlossaryEdit

pub fn affects_pages(&self) -> bool

Whether a term or citation key was renamed or removed, so page text may cite or use it.

pub fn with_page_effects( self, pages: &[DocumentRef<'_>], ) -> GlossaryReferencesResult

pages should hold every course page so renames reach all citations; it may be empty when GlossaryEdit::affects_pages is false.

Trait Implementations

impl Clone for GlossaryEdit

fn clone(&self) -> GlossaryEdit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlossaryEdit

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

Formats the value using the given formatter.

impl PartialEq for GlossaryEdit

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GlossaryEdit