Skip to main content

RenderOptions

Struct RenderOptions 

Source
pub struct RenderOptions {
    pub html_image_tags: bool,
    pub mermaid: bool,
    pub qr: bool,
    pub chess: bool,
    pub toc_depth: Option<u8>,
    pub layout_assets: Vec<String>,
    pub layout_fonts: Vec<String>,
}
Expand description

The pipeline flags mdcast render exposes, minus the ones that are meaningless over HTTP (--out, --assets DIR).

Fields§

§html_image_tags: bool

--html-image-tags: rewrite <img src="X"> / <image path="X"> to ![](X) before splitting.

§mermaid: bool

--mermaid: render ```mermaid fences to SVG before splitting.

§qr: bool

--qr: render ```qr fences and <qr> tags to SVG QR codes before splitting. Advertised as qr in CapabilitiesResponse::generators; a server without it ignores the flag.

§chess: bool

--chess: render ```fen / ```pgn fences and <fen> / <pgn> tags to SVG chess boards before splitting. Advertised as fen/pgn in CapabilitiesResponse::generators; a server without them ignores the flag and leaves the fences as code.

§toc_depth: Option<u8>

--toc-depth N: request a table of contents at heading depth 1-6.

§layout_assets: Vec<String>

--layout-asset KEY (repeatable): ResolvedDoc.assets entries a typst layout reaches via asset-path.

§layout_fonts: Vec<String>

--layout-font KEY (repeatable): ResolvedDoc.fonts entries to register with the typst font book.

Trait Implementations§

Source§

impl Clone for RenderOptions

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 RenderOptions

Source§

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

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

impl Default for RenderOptions

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for RenderOptions

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 Eq for RenderOptions

Source§

impl PartialEq for RenderOptions

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 RenderOptions

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 RenderOptions

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = !

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.