mathlex 0.4.1

Mathematical expression parser for LaTeX and plain text notation, producing a language-agnostic AST
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! ParseOutput struct for lenient (error-recovering) parsing results.

use super::types::{ParseError, ParseResult};

/// Output from lenient (error-recovering) parsing.
///
/// Contains a partial AST (if any portion was parseable) alongside
/// all errors encountered during parsing. This allows callers to
/// report multiple errors at once instead of stopping at the first.
///
/// # Examples
///
/// ```
/// use mathlex::error::ParseOutput;
/// use mathlex::ast::Expression;
///
/// // Successful parse with no errors
/// let output = ParseOutput {
///     expression: Some(Expression::integer(42)),
///     errors: vec![],
/// };
/// assert!(output.is_ok());
///
/// // Failed parse with errors
/// let output: ParseOutput = ParseOutput {
///     expression: None,
///     errors: vec![],
/// };
/// assert!(!output.is_ok());
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct ParseOutput {
    /// The (possibly partial) parsed expression.
    /// `None` if no valid expression could be recovered.
    pub expression: Option<crate::ast::Expression>,
    /// All errors encountered during parsing, in source order.
    pub errors: Vec<ParseError>,
}

impl ParseOutput {
    /// Returns `true` if parsing produced an expression with no errors.
    pub fn is_ok(&self) -> bool {
        self.expression.is_some() && self.errors.is_empty()
    }

    /// Returns `true` if any errors were encountered.
    pub fn has_errors(&self) -> bool {
        !self.errors.is_empty()
    }

    /// Converts a strict `ParseResult` into a `ParseOutput`.
    pub fn from_result(result: ParseResult<crate::ast::Expression>) -> Self {
        match result {
            Ok(expr) => Self {
                expression: Some(expr),
                errors: vec![],
            },
            Err(err) => Self {
                expression: None,
                errors: vec![err],
            },
        }
    }
}