Struct RenderConfig

pub struct RenderConfig<'a> {
    pub display_mode: DisplayMode,
    pub annotation: Option<&'a str>,
    pub error_color: (u8, u8, u8),
    pub xml: bool,
    pub math_style: MathStyle,
}

Configuration for the mathml renderer.

The default value is: RenderConfig::default.

Fields

display_mode: DisplayMode

See DisplayMode.

annotation: Option<&'a str>

If Some, the mathml generated includes an <annotation> element that contains the provided string. It is commonly used to include the LaTeX source code in the generated mathml.

error_color: (u8, u8, u8)

A RGB color. This option determines the color in which errors and invalid LaTeX commands are rendered in.

xml: bool

If true, a xml namespace (xmlns="http://www.w3.org/1998/Math/MathML") will be written into the <math> element.

This namespace is unnecessary for modern browsers but can be helpful for other user agents, such as Microsoft Word.

math_style: MathStyle

See MathStyle.

Implementations

impl<'a> RenderConfig<'a>

pub fn with_annotation(annotation: &'a str) -> Self

Create a new RenderConfig with the provided annotation, and default values for other fields.

Trait Implementations

impl<'a> Clone for RenderConfig<'a>

fn clone(&self) -> RenderConfig<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RenderConfig<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RenderConfig<'a>

fn default() -> Self

Default Value

const DEFAULT: RenderConfig = RenderConfig {
    display_mode: DisplayMode::Inline,
    annotation: None,
    error_color: (178, 34, 34),
    xml: false,
    math_style: MathStyle::TeX,
};
assert_eq!(RenderConfig::default(), DEFAULT);

impl<'a> PartialEq for RenderConfig<'a>

fn eq(&self, other: &RenderConfig<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for RenderConfig<'a>

impl<'a> StructuralPartialEq for RenderConfig<'a>