Struct ParseError 

pub struct ParseError {
    pub kind: Box<ParseErrorKind>,
    /* private fields */
}

Main error type thrown by KaTeX functions when something has gone wrong. This is used to distinguish internal errors from errors in the expression that the user provided.

Fields

kind: Box<ParseErrorKind>

Categorised reason for the failure.

Implementations

impl ParseError

pub fn new<T: Into<ParseErrorKind>>(kind: T) -> Self

Create a new ParseError with the given kind

pub fn with_token<T: Into<ParseErrorKind>>( kind: T, token: &dyn ErrorLocationProvider, ) -> Self

Create a new ParseError with context from a Token or ParseNode

pub const fn position(&self) -> Option<usize>

Get the start position of the error if available

pub const fn length(&self) -> Option<usize>

Get the length of the error if available

Trait Implementations

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for ParseError

fn from(_: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for ParseError

fn from(err: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseErrorKind> for ParseError

fn from(kind: ParseErrorKind) -> Self

Converts to this type from the input type.

impl From<ParseNodeError> for ParseError

Convert ParseNodeError to ParseError

fn from(err: ParseNodeError) -> Self

Converts to this type from the input type.