Struct QuoteBlock 

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

A blockquote: a quote, prose excerpt, or verse, optionally attributed to a person and a source citation.

A blockquote can be written in several ways, all of which produce this block:

• A delimited block bounded by lines of four underscores (____), optionally with a [quote,…] or [verse,…] attribute list. A quote block has the Compound content model (it contains other blocks); a verse block has the Simple content model and preserves its line breaks.
• A styled paragraph introduced by a [quote,…] or [verse,…] attribute list. This produces the Simple content model.
• A quoted paragraph: a paragraph wrapped in double quotes and followed by an attribution line introduced by two hyphens (-- …). This produces a quote block with the Simple content model.

Implementations

impl<'src> QuoteBlock<'src>

pub fn type_(&self) -> QuoteType

Returns the blockquote type (quote or verse).

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

Returns the rendered attribution (the person the content is attributed to), if any.

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

Returns the rendered citation title (the work the content is drawn from), if any.

pub fn content(&self) -> Option<&Content<'src>>

Returns the simple content of this blockquote, if it has the Simple content model.

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

Returns the nested blocks of a compound blockquote.

Unlike nested_blocks(), this also returns the blocks of a Markdown-style blockquote, which borrow the block’s own owned source rather than the document source and so are not exposed through the 'src-bound trait method.

Trait Implementations

impl<'src> Clone for QuoteBlock<'src>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuoteBlock<'_>

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

Formats the value using the given formatter.

impl<'src> Eq for QuoteBlock<'src>

impl<'src> HasSpan<'src> for QuoteBlock<'src>

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

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

impl<'src> IsBlock<'src> for QuoteBlock<'src>

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

Returns the nested blocks of a ____-delimited quote.

Note: a Markdown-style blockquote’s nested blocks borrow the block’s own owned source rather than the document source, so they cannot be returned through this 'src-bound trait method and this iterator is empty for them. Use QuoteBlock::blocks() to read the nested blocks of any compound quote, Markdown-style or not. (Rendering and reference resolution go through blocks() and an explicit crate-internal resolve_references, so this gap is internal to the crate.)

fn nested_blocks_mut(&mut self) -> &mut [Block<'src>]

Returns a mutable slice of the nested blocks of a ____-delimited quote.

See the note on nested_blocks(): a Markdown-style blockquote’s nested blocks are not reachable through this method.

fn content_model(&self) -> ContentModel

Returns the ContentModel for this block.

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

Returns the raw (uninterpreted) context for this block.

fn declared_style(&'src self) -> Option<&'src str>

Returns the declared (uninterpreted) style for this block.

fn rendered_content(&'src self) -> Option<&'src str>

Returns the rendered content for this block, if any.

fn content_mut(&mut self) -> Option<&mut Content<'src>>

Returns a mutable reference to this block’s own resolvable content — its body, section title, or description-list term — if any.

fn title_source(&'src self) -> Option<Span<'src>>

Returns the source text for the title for this block, if present.

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

Returns the rendered title for this block, if present.

fn anchor(&'src self) -> Option<Span<'src>>

Returns the anchor for this block, if present.

fn anchor_reftext(&'src self) -> Option<Span<'src>>

Returns the reference text for this block’s anchor, if present.

fn attrlist(&'src self) -> Option<&'src Attrlist<'src>>

Returns the attribute list for this block, if present.

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

Returns the resolved context for this block.

fn id(&'src self) -> Option<&'src str>

Returns the ID for this block, if present.

fn roles(&'src self) -> Vec<&'src str>

Returns any role attributes that were found.

fn options(&'src self) -> Vec<&'src str>

Returns any option attributes that were found.

fn has_option<N: AsRef<str>>(&'src self, name: N) -> bool

Returns true if this block has the named option.

fn caption(&self) -> Option<&str>

Returns the caption prefix for this block, if it has one.

fn number(&self) -> Option<usize>

Returns the automatically assigned number for this block, if it has one.

fn substitution_group(&'src self) -> SubstitutionGroup

Returns the default substitution group that is applied unless you customize the substitutions for a particular element.

impl<'src> PartialEq for QuoteBlock<'src>

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