Enum SubstitutionGroup

pub enum SubstitutionGroup {
    Normal,
    Header,
    Verbatim,
    Pass,
    None,
    AttributeEntryValue,
    Custom(Vec<SubstitutionStep>),
}

Each block and inline element has a default substitution group that is applied unless you customize the substitutions for a particular element.

SubstitutionGroup specifies the default or overridden substitution group to be applied.

Variants

Normal

The normal substitution group is applied to the majority of the AsciiDoc block and inline elements except for specific elements described in the next sections.

Header

The header substitution group is applied to metadata lines (author and revision information) in the document header. It’s also applied to the values of attribute entries, regardless of whether those entries are defined in the document header or body. Only special characters, attribute references, and the inline pass macro are replaced in elements that fall under the header group.

You can use the inline pass macro in attribute entries to customize the substitution types applied to the attribute’s value.

Verbatim

Literal, listing, and source blocks are processed using the verbatim substitution group. Only special characters are replaced in these blocks.

Pass

No substitutions are applied to three of the elements in the pass substitution group. These elements include the passthrough block, inline pass macro, and triple plus macro.

The inline single plus and double plus macros also belong to the pass group. Only the special characters substitution is applied to these elements.

None

The none substitution group is applied to comment blocks. No substitutions are applied to comments.

AttributeEntryValue

The attribute entry value substitution group is applied to attribute values. Only special characters and attribute references are applied to these values.

Custom(Vec<SubstitutionStep>)

You can customize the substitutions applied to the content of an inline pass macro by specifying one or more substitution values. Multiple values must be separated by commas and may not contain any spaces. The substitution value is either the formal name of a substitution type or group, or its shorthand.

See Custom substitutions.

Trait Implementations

impl Clone for SubstitutionGroup

fn clone(&self) -> SubstitutionGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubstitutionGroup

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

Formats the value using the given formatter.

impl PartialEq for SubstitutionGroup

fn eq(&self, other: &SubstitutionGroup) -> 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 Eq for SubstitutionGroup

impl StructuralPartialEq for SubstitutionGroup