Enum IndexTermKind 

#[non_exhaustive]
pub enum IndexTermKind<'a> {
    Flow(Vec<InlineNode<'a>>),
    Concealed {
        term: Vec<InlineNode<'a>>,
        secondary: Option<Vec<InlineNode<'a>>>,
        tertiary: Option<Vec<InlineNode<'a>>>,
    },
}

The kind of index term, encoding both visibility and structure.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Flow(Vec<InlineNode<'a>>)

A single term that is visible in the document and included in the index.

Concealed

Hidden from output, supports hierarchical entries.

Fields

term: Vec<InlineNode<'a>>

The primary inline label.

secondary: Option<Vec<InlineNode<'a>>>

The secondary inline label, if present.

tertiary: Option<Vec<InlineNode<'a>>>

The tertiary inline label, if present.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'a> PartialEq for IndexTermKind<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for IndexTermKind<'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 IndexTermKind<'a>