Struct Content 

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

Describes the annotated content of a block after any relevant substitutions have been performed.

This is typically used to represent the main body of block types that don’t contain other blocks, such as SimpleBlock or RawDelimitedBlock.

Deferred cross-references

Cross-references (<<id>>, xref:id[…]) cannot be resolved while a block is being parsed, because their target may be defined later in the document (or, for multi-document workflows, in another document entirely). The macros substitution therefore records each cross-reference in a deferred form and leaves an opaque placeholder in the rendered text. The references are resolved in a later pass — see Document::resolve_references — at which point rendered() reflects the resolved links. Until then, rendered() shows an unresolved fallback, so it always returns clean text.

Implementations

impl<'src> Content<'src>

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

Returns the original span from which this Content was derived.

This is the source text before any substitions have been applied.

pub fn rendered(&'src self) -> &'src str

Returns the final text after all substitutions have been applied.

pub fn is_empty(&self) -> bool

Returns true if self contains no text.

pub fn has_unresolved_refs(&self) -> bool

Returns true if this content contains one or more cross-references that have not yet been resolved to a destination.

Trait Implementations

impl<'src> Clone for Content<'src>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Content<'_>

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

Formats the value using the given formatter.

impl<'src> Eq for Content<'src>

impl<'src> From<Span<'src>> for Content<'src>

fn from(span: Span<'src>) -> Self

Converts to this type from the input type.

impl<'src> PartialEq for Content<'src>

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