Skip to main content

PipelineConfig

Struct PipelineConfig 

Source
pub struct PipelineConfig {
    pub markdown_gfm: Option<bool>,
    pub pretty_code: Option<PrettyCodeOptions>,
    pub math_engine: Option<MathEngine>,
    pub copy_linked_files: Option<CopyLinkedFilesOptions>,
    pub emoji: Option<bool>,
    pub autolink_headings: Option<bool>,
    pub math: Option<bool>,
    pub pretty_code_enabled: Option<bool>,
    pub mermaid: Option<MermaidOptions>,
    pub mermaid_enabled: Option<bool>,
}
Expand description

Top-level config consumed by crate::Pipeline::with_defaults_for. All fields are optional; the empty config (PipelineConfig::default()) reproduces the historical Pipeline::with_defaults() behavior.

Fields§

§markdown_gfm: Option<bool>

When false, append the disable-gfm transformer that strips GFM extensions (tables, strikethrough, autolinks, task lists).

§pretty_code: Option<PrettyCodeOptions>

Pretty-code theme + multi-mode settings. None keeps the bundled defaults (Catppuccin Latte/Mocha pair, dark primary).

§math_engine: Option<MathEngine>

LaTeX rendering engine. None -> MathEngine::Katex.

§copy_linked_files: Option<CopyLinkedFilesOptions>

When Some, append the copy-linked-files transformer with the supplied paths.

§emoji: Option<bool>

When Some(false), do not push the Emoji transformer. None or Some(true) keeps the default behaviour (transformer added when the emoji feature is on). Used by the plugin gate to drop the native transformer when the user prefers remark-emoji.

§autolink_headings: Option<bool>

Same shape for the AutolinkHeadings transformer. Set to Some(false) when the user prefers rehype-slug / rehype-autolink-headings.

§math: Option<bool>

Same shape for the Math transformer. Set to Some(false) when the user prefers remark-math / rehype-katex / rehype-mathjax.

§pretty_code_enabled: Option<bool>

Same shape for the PrettyCode transformer. Set to Some(false) when the user prefers rehype-pretty-code / shiki.

§mermaid: Option<MermaidOptions>

Mermaid render config. None keeps the bundled defaults (light + dark theme pair, htmlLabels:false, responsive SVG, centered labels).

§mermaid_enabled: Option<bool>

Same shape for the Mermaid transformer. Some(false) drops the transformer (mermaid blocks left as code fences).

Trait Implementations§

Source§

impl Clone for PipelineConfig

Source§

fn clone(&self) -> PipelineConfig

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 PipelineConfig

Source§

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

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

impl Default for PipelineConfig

Source§

fn default() -> PipelineConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PipelineConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PipelineConfig

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,