Enum IndexTermKind 

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

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

This enum makes invalid states unrepresentable: flow terms can only have a single term (no hierarchy), while concealed terms support up to three hierarchical levels.

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(String)

Visible in output, single term only.

Created by ((term)) or indexterm2:[term].

Concealed

Hidden from output, supports hierarchical entries.

Created by (((term,secondary,tertiary))) or indexterm:[term,secondary,tertiary].

Fields

term: String

secondary: Option<String>

tertiary: Option<String>

Trait Implementations

impl Clone for IndexTermKind

fn clone(&self) -> IndexTermKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexTermKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexTermKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IndexTermKind

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

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 IndexTermKind