Struct LatexToMathML

pub struct LatexToMathML { /* private fields */ }

A converter that transforms LaTeX math equations into MathML Core.

Implementations

impl LatexToMathML

pub fn new(config: &MathCoreConfig) -> Result<Self, LatexError<'_>>

Create a new LatexToMathML converter with the given configuration.

This function returns an error if the custom macros in the given configuration could not be parsed.

pub const fn const_default() -> Self

Create a new LatexToMathML converter with default settings.

pub fn convert_with_global_counter<'config, 'source>( &'config mut self, latex: &'source str, display: MathDisplay, ) -> Result<String, LatexError<'source>>

where 'config: 'source,

Convert LaTeX text to MathML with a global equation counter.

For basic usage, see the documentation of [convert_with_local_counter].

This conversion function maintains state, in order to count equations correctly across different calls to this function.

The counter can be reset with [reset_global_counter].

pub fn convert_with_local_counter<'config, 'source>( &'config self, latex: &'source str, display: MathDisplay, ) -> Result<String, LatexError<'source>>

where 'config: 'source,

Convert LaTeX text to MathML.

The second argument specifies whether it is inline-equation or block-equation.

use math_core::{LatexToMathML, MathCoreConfig, MathDisplay};

let latex = r#"(n + 1)! = \Gamma ( n + 1 )"#;
let config = MathCoreConfig::default();
let converter = LatexToMathML::new(&config).unwrap();
let mathml = converter.convert_with_local_counter(latex, MathDisplay::Inline).unwrap();
println!("{}", mathml);

let latex = r#"x = \frac{ - b \pm \sqrt{ b^2 - 4 a c } }{ 2 a }"#;
let mathml = converter.convert_with_local_counter(latex, MathDisplay::Block).unwrap();
println!("{}", mathml);

pub fn reset_global_counter(&mut self)

Reset the equation counter to zero.

This should normally be done at the beginning of a new document or section.

Trait Implementations

impl Debug for LatexToMathML

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

Formats the value using the given formatter.