Struct IndexEntry 

pub struct IndexEntry {
    pub link_text: String,
    pub dest: String,
    pub description: String,
    pub separator: Option<char>,
    pub text_span: Range<usize>,
    pub tail_span: Range<usize>,
    pub line_span: Range<usize>,
}

One list entry of an index: a list item that starts with a link.

Fields

link_text: String

Source text of the link text (between [ and the matching ]).

dest: String

Link destination as interpreted by pulldown-cmark (without <...> and the title attribute). Used for comparison and resolution only; never written back.

description: String

Summary with the separator and surrounding whitespace removed.

separator: Option<char>

One of - – — :, if present.

text_span: Range<usize>

From just after [ to just before the matching ].

tail_span: Range<usize>

From the end of the link to the end of the inline content (separator + summary, may span lines).

line_span: Range<usize>

From the start of the line containing text_span.start through the line terminator (\n or \r\n) after tail_span.end.

Trait Implementations

impl Clone for IndexEntry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexEntry

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

Formats the value using the given formatter.

impl Eq for IndexEntry

impl PartialEq for IndexEntry

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IndexEntry