Struct ToctreeRecord 

pub struct ToctreeRecord {
    pub glob: bool,
    pub entries: Vec<ToctreeEntryRecord>,
    pub caption: Option<String>,
    pub source: u16,
    pub line: u32,
    pub warnings: Vec<ToctreeWarning>,
}

A toctree directive occurrence (sphinx mode).

Fields

glob: bool

entries: Vec<ToctreeEntryRecord>

caption: Option<String>

The optional caption is a title in Sphinx’s search index; entry labels and targets are not searchable body text.

source: u16

Source-table index of the .. toctree:: line — the section- numbering warning (location=toctreenode) names this source’s path. Not #[serde(default)] (see DirectiveRecord::source).

line: u32

1-based line of the directive, within source.

warnings: Vec<ToctreeWarning>

Diagnostics TocTree.parse_content produced while resolving this directive’s entries. They ride the record (and therefore the document cache) because the parser has no warning sink, and because a cache hit that skipped the parse must still reproduce them.

Trait Implementations

impl Clone for ToctreeRecord

fn clone(&self) -> ToctreeRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToctreeRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToctreeRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToctreeRecord

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.