Struct BlockSelector 

pub struct BlockSelector<'a> { /* private fields */ }

A declarative selector for FindBlocks::find_blocks, mirroring the selector hash of Asciidoctor’s find_by.

Build one with new and the builder methods. A field that is left unset matches any block; when several fields are set they are combined with logical AND.

Method	Matches against
context	IsBlock::resolved_context
style	IsBlock::declared_style (see below)
id	IsBlock::id
role	membership in IsBlock::roles

style matches declared_style, which is the block’s resolved style and tracks Asciidoctor’s style in the common cases — including variant blocks that report their style even in shorthand form (e.g. an admonition written NOTE: matches style("NOTE")). The one divergence: a style that masquerades as a built-in context (e.g. [example], [sidebar]) is promoted to the block’s context, so match those with context rather than style.

use asciidoc_parser::{
    Parser,
    blocks::{BlockSelector, FindBlocks},
};

let doc = Parser::default().parse("[#intro]\nHello.\n");
let block = doc.find_blocks(&BlockSelector::new().id("intro")).next();
assert!(block.is_some());

Implementations

impl<'a> BlockSelector<'a>

pub fn new() -> Self

Creates a selector that matches every block.

pub fn context(self, context: impl Into<Cow<'a, str>>) -> Self

Restricts the match to blocks whose resolved context equals context (e.g. "listing", "section", "sidebar").

pub fn style(self, style: impl Into<Cow<'a, str>>) -> Self

Restricts the match to blocks whose declared style equals style (e.g. "source", "verse", "NOTE").

pub fn id(self, id: impl Into<Cow<'a, str>>) -> Self

Restricts the match to the block whose id equals id.

pub fn role(self, role: impl Into<Cow<'a, str>>) -> Self

Restricts the match to blocks that carry role among their roles.

pub fn traverse_documents(self, traverse_documents: bool) -> Self

Sets whether the traversal descends into AsciiDoc table cells (nested documents). Off by default.

pub fn matches(&self, block: &Block<'_>) -> bool

Returns true if block satisfies every field this selector sets.

This does not consider traverse_documents, which governs traversal rather than whether an individual block matches.

Trait Implementations

impl<'a> Clone for BlockSelector<'a>

fn clone(&self) -> BlockSelector<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BlockSelector<'a>

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

Formats the value using the given formatter.

impl<'a> Default for BlockSelector<'a>

fn default() -> BlockSelector<'a>

Returns the “default value” for a type.