Struct IndexTerm 

#[non_exhaustive]
pub struct IndexTerm {
    pub kind: IndexTermKind,
    pub location: Location,
}

An IndexTerm represents an index term in a document.

Index terms can be either:

• Flow terms (visible): ((term)) or indexterm2:[term] - the term appears in the text
• Concealed terms (hidden): (((term,secondary,tertiary))) or indexterm:[term,secondary,tertiary]
  • only appears in the index

Concealed terms support hierarchical entries with primary, secondary, and tertiary levels.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: IndexTermKind

The kind and content of this index term.

location: Location

Implementations

impl IndexTerm

pub fn term(&self) -> &str

Returns the primary term.

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

Returns the secondary term, if any.

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

Returns the tertiary term, if any.

pub fn is_visible(&self) -> bool

Returns whether this term is visible in the output.

Trait Implementations

impl Clone for IndexTerm

fn clone(&self) -> IndexTerm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexTerm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexTerm

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IndexTerm

fn eq(&self, other: &IndexTerm) -> 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 Serialize for IndexTerm

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IndexTerm