Skip to main content

Passthrough

Struct Passthrough 

Source
pub struct Passthrough { /* private fields */ }
Expand description

Records one inline passthrough (+++…+++, ++…++, $$…$$, pass:[…], or an inline STEM macro) that the substitution pipeline extracted from a block’s content before running the other substitutions, and restores afterward.

The collection of these for a block is observable via Content::passthroughs, analogous to Asciidoctor’s internal @passthroughs array. It exposes, for each entry, the stored (unescaped) source text and the resolved subs that are applied to that text on restore.

Implementations§

Source§

impl Passthrough

Source

pub fn text(&self) -> &str

Returns the stored, unescaped source text of this passthrough – the text that is substituted back in (after applying subs) when the passthrough is restored.

This mirrors the :text of an entry in Asciidoctor’s @passthroughs array.

Source

pub fn subs(&self) -> &SubstitutionGroup

Returns the resolved substitution group applied to this passthrough’s text when it is restored, i.e. the ordered set of substitution steps in effect for it.

For example, +++…+++ resolves to SubstitutionGroup::None (no substitutions), while ++…++ and $$…$$ resolve to SubstitutionGroup::Verbatim (special characters). This mirrors the resolved :subs of an entry in Asciidoctor’s @passthroughs array.

Trait Implementations§

Source§

impl Clone for Passthrough

Source§

fn clone(&self) -> Passthrough

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 Passthrough

Source§

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

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

impl Eq for Passthrough

Source§

impl Hash for Passthrough

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 Passthrough

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Passthrough

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.