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.

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

Return an iterator over the attributes 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<'src> Debug for Header<'src>

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

Formats the value using the given formatter.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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