KaTeXOptions

Struct KaTeXOptions 

Source
pub struct KaTeXOptions {
    pub display_mode: bool,
    pub left_equation_numbers: bool,
    pub flush_left_equations: bool,
    pub throw_on_error: bool,
    pub min_rule_thickness: f64,
    pub max_size: f64,
    pub max_expand: i32,
    pub strict: bool,
    pub trust: bool,
    pub global_group: bool,
    /* private fields */
}
Expand description

Read https://katex.org/docs/options.html for more information.

Fields§

§display_mode: bool

Whether to render the math in the display mode.

§left_equation_numbers: bool

If true, display math has \tags rendered on the left instead of the right.
like \usepackage[leqno]{amsmath} in LaTeX.

§flush_left_equations: bool

If true, display math renders flush left with a 2em left margin
like \documentclass[fleqn] in LaTeX with the amsmath package.

§throw_on_error: bool

Whether to let KaTeX throw a ParseError for invalid LaTeX.

§min_rule_thickness: f64

Color used for invalid LaTeX. Specifies a minimum thickness, in ems.

§max_size: f64

Max size for user-specified sizes. If set to None, users can make elements and spaces arbitrarily large.

§max_expand: i32

Limit the number of macro expansions to the specified number. If set to None, the macro expander will try to fully expand as in LaTeX.

§strict: bool

strict mode

§trust: bool

Whether to trust users’ input. Cannot be assigned at the same time with [OptsBuilder::trust_callback].

§global_group: bool

group

Implementations§

Source§

impl KaTeXOptions

Source

pub fn display_mode() -> KaTeXOptions

Set output as \displaystyle

Source

pub fn inline_mode() -> KaTeXOptions

Set output as \inlinestyle

Source

pub fn render(&self, input: &str) -> String

Render formulas to html string.

Source§

impl KaTeXOptions

Source

pub fn set_output_format(&mut self, format: &str) -> bool

Determines the markup language of the output.
The valid choices are:

  • html: Outputs KaTeX in HTML only.
  • mathml: Outputs KaTeX in MathML only.
  • htmlAndMathml: Outputs HTML for visual rendering and includes MathML for accessibility. This is the default.
Source

pub fn set_error_color(&mut self) -> bool

Set the color of the error message.

Source

pub fn insert_macro_rule(&mut self) -> bool

Insert a custom macro.

Trait Implementations§

Source§

impl Clone for KaTeXOptions

Source§

fn clone(&self) -> KaTeXOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KaTeXOptions

Source§

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

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

impl Default for KaTeXOptions

Source§

fn default() -> KaTeXOptions

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

impl<'de> Deserialize<'de> for KaTeXOptions

Source§

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

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

impl Serialize for KaTeXOptions

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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> 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> To for T
where T: ?Sized,

Source§

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.
Source§

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.
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> 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
Source§

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