Struct MarkdownDocument 

pub struct MarkdownDocument { /* private fields */ }

A parsed Markdown document.

Implementations

impl MarkdownDocument

pub fn new(source: impl Into<String>) -> Self

Creates a document by parsing Markdown with the supported GFM extensions enabled.

pub fn empty() -> Self

Returns an empty Markdown document.

pub fn parse(source: impl Into<String>) -> Self

Parses Markdown with the supported GFM extensions enabled.

pub fn from_source(source: impl Into<String>) -> Self

Alias for Self::parse that makes the source-oriented API explicit.

pub fn parse_with_metadata( source_path: Option<String>, title: Option<String>, source: impl Into<String>, ) -> Self

Parses Markdown while retaining optional host-provided metadata.

pub fn source(&self) -> &str

Returns the original source, including its original line endings.

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

Returns the optional source path supplied by the host.

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

Returns the optional display title supplied by the host.

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

Returns the top-level semantic blocks.

pub fn outline(&self) -> &[MarkdownHeading]

Returns headings in document order.

pub fn targets(&self) -> &[MarkdownTarget]

Returns all commentable targets in document order.

pub fn target(&self, id: MarkdownTargetId) -> Option<&MarkdownTarget>

Finds a target by its document-local ID.

Trait Implementations

impl Clone for MarkdownDocument

fn clone(&self) -> MarkdownDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MarkdownDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MarkdownDocument

impl PartialEq for MarkdownDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MarkdownDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MarkdownDocument