Struct IndexTerm 

#[non_exhaustive]
pub struct IndexTerm<'a> {
    pub kind: IndexTermKind<'a>,
    pub relationship: Option<IndexTermRelationship<'a>>,
    pub location: Location,
    /* private fields */
}

An IndexTerm represents an index term in a document.

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<'a>

The kind and content of this index term.

relationship: Option<IndexTermRelationship<'a>>

The relationship from this entry to other index terms.

location: Location

Implementations

impl<'a> IndexTerm<'a>

pub fn catalog_entry(&self) -> &Self

Returns the labels registered in the index catalog.

These can differ from the displayed term when substitutions run after index registration. The returned entry is not another occurrence.

pub fn term(&self) -> &[InlineNode<'a>]

Returns the primary term.

pub fn secondary(&self) -> Option<&[InlineNode<'a>]>

Returns the secondary term, if any.

pub fn tertiary(&self) -> Option<&[InlineNode<'a>]>

Returns the tertiary term, if any.

pub fn is_visible(&self) -> bool

Returns whether this term is visible in the output.

Trait Implementations

impl<'a> Clone for IndexTerm<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for IndexTerm<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for IndexTerm<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for IndexTerm<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for IndexTerm<'a>