Skip to main content

Document

Struct Document 

Source
pub struct Document { /* private fields */ }
Expand description

An owned, immutable Markdown document and its navigation indexes.

Construct a document with Document::parse or Document::parse_with_limits. Blocks, headings, and links all refer to the same parse, so renderers can share heading and link identities without rebuilding indexes. Cloning a document performs a deep clone; use std::sync::Arc when several consumers should share one allocation.

Implementations§

Source§

impl Document

Source

pub fn blocks(&self) -> &[Block]

Returns the top-level semantic blocks in source order.

Blocks nested inside quotations and list items are available through BlockKind::Quote and ListItem::blocks.

Source

pub fn headings(&self) -> &[Heading]

Returns the heading index in source order.

Returns links in parse traversal order.

Resolves a document-local link identifier.

Returns None when the identifier’s index is outside this document. Because IDs are document-local indexes, callers must not reuse one with another document or revision.

Source§

impl Document

Source

pub fn parse(source: &str) -> Result<Self, ParseError>

Parses CommonMark with tables, task lists, and strikethrough enabled.

Parsing is synchronous, performs no I/O, and returns an owned document that does not borrow source. Incomplete syntax follows pulldown-cmark’s literal fallback rules.

§Errors

Returns ParseError if the default resource limits are exceeded.

Source

pub fn parse_with_limits( source: &str, limits: ParseLimits, ) -> Result<Self, ParseError>

Parses with caller-supplied resource bounds.

The same Markdown extensions and ownership rules as Document::parse apply. See ParseLimits for boundary semantics.

§Errors

Returns ParseError when any bound is exceeded.

Trait Implementations§

Source§

impl Clone for Document

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Document

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Document

Source§

impl PartialEq for Document

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Document

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.