Struct Document

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

A document represents the top-level block element in AsciiDoc. It consists of an optional document header and either a) one or more sections preceded by an optional preamble or b) a sequence of top-level blocks only.

The document can be configured using a document header. The header is not a block itself, but contributes metadata to the document, such as the document title and document attributes.

Implementations

impl<'src> Document<'src>

pub fn parse(source: &'src str) -> Self

Parse a UTF-8 string as an AsciiDoc document.

Note that the document references the underlying source string and necessarily has the same lifetime as the source.

The Document data structure returned by this call and nearly all data structures contained within it are gated by the lifetime of the source text passed in to this function. For that reason all of those data structures are given the lifetime 'src.

IMPORTANT: The AsciiDoc language documentation states that UTF-16 encoding is allowed if a byte-order-mark (BOM) is present at the start of a file. This format is not directly supported by the asciidoc-parser crate. Any UTF-16 content must be re-encoded as UTF-8 prior to parsing.

Any UTF-8 string is a valid AsciiDoc document, so there is no Option or Result on this API. There may be any number of character sequences that have ambiguous or potentially unintended meanings. For that reason, a caller is advised to review the warnings provided via the Self::warnings iterator.

pub fn header(&'src self) -> &'src Header<'src>

Return the document header.

pub fn warnings(&'src self) -> Iter<'src, Warning<'src>>

Return an iterator over any warnings found during parsing.

Trait Implementations

impl<'src> Clone for Document<'src>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for Document<'src>

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

Formats the value using the given formatter.

impl<'src> HasSpan<'src> for Document<'src>

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

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

impl<'src> IsBlock<'src> for Document<'src>

fn content_model(&self) -> ContentModel

Returns the ContentModel for this block.

fn context(&self) -> CowStr<'src>

Returns the context for this block.

fn nested_blocks(&'src self) -> Iter<'src, Block<'src>>

Returns an iterator over the nested blocks contained within this block.

impl<'src> PartialEq for Document<'src>

fn eq(&self, other: &Document<'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 Document<'src>

impl<'src> StructuralPartialEq for Document<'src>