Enum IndexTermRelationship 

#[non_exhaustive]
pub enum IndexTermRelationship<'a> {
    See {
        target: Vec<InlineNode<'a>>,
    },
    SeeAlso {
        targets: Vec<Vec<InlineNode<'a>>>,
    },
}

A relationship from an index entry to another index term.

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.

See

Readers should use the target term instead of this entry.

Fields

target: Vec<InlineNode<'a>>

The replacement index term.

SeeAlso

Readers can also consult the related terms.

Fields

targets: Vec<Vec<InlineNode<'a>>>

The related index terms.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'a> PartialEq for IndexTermRelationship<'a>

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

Equality operator ==.

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

Inequality operator !=.

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