Struct ResolvedEntries 

pub struct ResolvedEntries {
    pub entries: Vec<(Option<String>, String)>,
    pub includefiles: Vec<String>,
    pub warnings: Vec<ToctreeWarning>,
}

toctree['entries'] (title, ref) pairs plus toctree['includefiles'].

Fields

entries: Vec<(Option<String>, String)>

(title, ref); ref is a resolved docname, an external URL, or the literal self.

includefiles: Vec<String>

The subset of entries that are real documents, in the same order.

warnings: Vec<ToctreeWarning>

Diagnostics for the entries that did not resolve. The single source of truth for toctree warnings: nothing downstream re-resolves.

Implementations

impl ResolvedEntries

pub fn entries_attr(&self) -> AttrValue

The entries attribute as docutils renders it: one Python tuple repr per item ((None, 'intro')), which pformat then serial_escapes and joins.

pub fn includefiles_attr(&self) -> AttrValue

Trait Implementations

impl Clone for ResolvedEntries

fn clone(&self) -> ResolvedEntries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResolvedEntries

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

Formats the value using the given formatter.

impl Default for ResolvedEntries

fn default() -> ResolvedEntries

Returns the “default value” for a type.

impl Eq for ResolvedEntries

impl PartialEq for ResolvedEntries

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ResolvedEntries