Enum BuiltInContext 

#[non_exhaustive]
pub enum BuiltInContext {
    Admonition,
    Audio,
    Colist,
    Dlist,
    Document,
    Example,
    FloatingTitle,
    Image,
    ListItem,
    Listing,
    Literal,
    Olist,
    Open,
    PageBreak,
    Paragraph,
    Pass,
    Preamble,
    Quote,
    Section,
    Sidebar,
    Stem,
    Table,
    TableCell,
    ThematicBreak,
    Toc,
    Ulist,
    Verse,
    Video,
}

The set of built-in block contexts defined by the AsciiDoc language.

A block’s context (see IsBlock::resolved_context) is a stringly-typed value so that third-party extensions can introduce their own contexts. The contexts understood natively by this parser, however, are drawn from a fixed vocabulary. This enum names that vocabulary so a downstream consumer (for example, a converter that dispatches on resolved_context) can match against a shared definition rather than hard-coding and maintaining its own copy of the context strings.

Use from_str to classify a context string (such as the value returned by resolved_context) and as_str to recover the canonical string for a variant.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Admonition

The admonition context.

Audio

The audio context.

Colist

The colist (callout list) context.

Dlist

The dlist (description list) context.

Document

The document context.

Example

The example context.

FloatingTitle

The floating_title (discrete heading) context.

Image

The image context.

ListItem

The list_item context.

Listing

The listing context.

Literal

The literal context.

Olist

The olist (ordered list) context.

Open

The open context.

PageBreak

The page_break context.

Paragraph

The paragraph context.

Pass

The pass (passthrough) context.

Preamble

The preamble context.

Quote

The quote context.

Section

The section context.

Sidebar

The sidebar context.

Stem

The stem context.

Table

The table context.

TableCell

The table_cell context.

ThematicBreak

The thematic_break context.

Toc

The toc context.

Ulist

The ulist (unordered list) context.

Verse

The verse context.

Video

The video context.

Implementations

impl BuiltInContext

pub const ALL: &'static [BuiltInContext]

Every built-in context, in a stable order.

This lets a consumer enumerate the full vocabulary (for example, to build a dispatch table keyed by as_str).

pub fn as_str(self) -> &'static str

Returns the canonical context string for this variant (e.g., "paragraph").

This is the same string that resolved_context yields for a block of this context.

pub fn from_str(context: &str) -> Option<Self>

Resolves a context string to its BuiltInContext variant, or None if the string is not a built-in context.

The match is case-sensitive: built-in contexts are always lowercase.

Trait Implementations

impl Clone for BuiltInContext

fn clone(&self) -> BuiltInContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BuiltInContext

impl Debug for BuiltInContext

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

Formats the value using the given formatter.

impl Eq for BuiltInContext

impl Hash for BuiltInContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BuiltInContext

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BuiltInContext