Struct IndexTerm 

#[non_exhaustive]
pub struct IndexTerm<'a> {
    pub kind: IndexTermKind<'a>,
    pub location: Location,
}

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.

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<'a> Clone for IndexTerm<'a>

fn clone(&self) -> IndexTerm<'a>

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: &IndexTerm<'a>) -> 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<'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>