Skip to main content

SubstitutionSpec

Enum SubstitutionSpec 

Source
pub enum SubstitutionSpec {
    Source(Vec<String>),
    Explicit(Vec<Substitution>),
    Modifiers(Vec<SubstitutionOp>),
}
Expand description

Specification for substitutions to apply to a block.

Parsed documents use Self::Source to preserve the entries in the subs attribute, including groups, aliases, duplicates and modifiers. Only whitespace around each entry is trimmed. Attribute references in the list have already been expanded by metadata parsing.

Standalone none and empty values use Self::Explicit with an empty list. They disable substitutions, whereas absent metadata uses block defaults. Mixed lists retain none because its position can select the starting list.

Self::resolve derives the effective stages without changing the stored entries. A plain first entry starts an empty list; a modifier first entry starts with the supplied block defaults. Later entries operate on that list. Self::Explicit and Self::Modifiers also support typed construction.

§Serialization

Serializes to a flat array. Source entries retain their spelling, for example ["verbatim", "-macros"]; typed entries use canonical names such as "special_chars".

Only available when the pre-spec-subs feature is enabled.

Variants§

§

Source(Vec<String>)

Authored entries, interpreted when resolving against block defaults.

§

Explicit(Vec<Substitution>)

Explicit list of substitutions to apply (replaces all defaults)

§

Modifiers(Vec<SubstitutionOp>)

Modifier operations to apply to block-type defaults

Implementations§

Source§

impl SubstitutionSpec

Source

pub fn apply_modifiers( ops: &[SubstitutionOp], default: &[Substitution], ) -> Vec<Substitution>

Apply modifier operations to a default substitution list.

This is used by converters to resolve modifiers with the appropriate baseline.

Source

pub fn resolve(&self, default: &[Substitution]) -> Vec<Substitution>

Resolve the substitution spec to a concrete list of substitutions.

  • For Source, applies its entries in order, expanding named groups
  • For Explicit, returns the list directly
  • For Modifiers, applies the operations to the provided default

Trait Implementations§

Source§

impl Clone for SubstitutionSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SubstitutionSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SubstitutionSpec

Source§

impl Hash for SubstitutionSpec

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SubstitutionSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for SubstitutionSpec

Available on crate feature pre-spec-subs only.
Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SubstitutionSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more