Struct Header 

pub struct Header<'src> { /* private fields */ }

An AsciiDoc document may begin with a document header. The document header encapsulates the document title, author and revision information, document-wide attributes, and other document metadata.

Implementations

impl<'src> Header<'src>

pub fn title_source(&'src self) -> Option<Span<'src>>

Return a Span describing the raw document title, if there was one.

pub fn title(&self) -> Option<&str>

Return the document’s title, if there was one, having applied header substitutions.

If the title contains a subtitle (see subtitle), this returns the full, combined title. Use main_title to obtain only the portion preceding the subtitle.

pub fn main_title(&self) -> Option<&str>

Return the main portion of the document title, if there was a title.

When the document title contains a subtitle separator (a colon followed by a space, by default), the title is partitioned into a main title and a subtitle. This returns the portion preceding the final separator. When there is no subtitle, this is identical to title.

pub fn subtitle(&self) -> Option<&str>

Return the document’s subtitle, if the title contained one.

A subtitle is the text following the final subtitle separator in the document title. The separator defaults to a colon followed by a space (:{sp}) and can be overridden with the title-separator document attribute. Returns None when the title has no subtitle.

pub fn attributes(&'src self) -> Iter<'src, Attribute<'src>>

Return an iterator over the attributes in this header.

pub fn author_line(&self) -> Option<&AuthorLine<'src>>

Returns the author line, if found.

pub fn authors(&self) -> &[Author]

Returns the document’s authors.

Authors may be declared on the author line or via the author / author_N (and companion email_N, …) document attributes; this returns the resolved list regardless of which mechanism was used. When the document has no author information, the slice is empty.

pub fn revision_line(&self) -> Option<&RevisionLine<'src>>

Returns the revision line, if found.

pub fn comments(&'src self) -> Iter<'src, Span<'src>>

Return an iterator over the comments in this header.

Trait Implementations

impl<'src> Clone for Header<'src>

fn clone(&self) -> Header<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header<'_>

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

Formats the value using the given formatter.

impl<'src> Eq for Header<'src>

impl<'src> HasSpan<'src> for Header<'src>

fn span(&self) -> Span<'src>

Return a Span describing the syntactic element’s location within the source string/file.

impl<'src> PartialEq for Header<'src>

fn eq(&self, other: &Header<'src>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'src> StructuralPartialEq for Header<'src>