Struct OakError 

pub struct OakError { /* private fields */ }

The main error type for the Oak Core parsing framework.

OakError represents all possible language that can occur during lexical analysis and parsing operations. It provides detailed error information including error kind and/// precise source location.

Implementations

impl OakError

pub fn test_failure(path: PathBuf, expected: String, actual: String) -> Self

Creates a test failure error.

pub fn test_regenerated(path: PathBuf) -> Self

Creates a test regenerated error.

pub fn io_error(error: Error, url: Url) -> Self

Creates an I/O error with optional file URL.

Arguments

• error - The underlying I/O error
• url - URL of the file that caused the error

Examples

let io_err = io::Error::new(io::ErrorKind::NotFound, "File not found");
let error = OakError::io_error(io_err, url::Url::parse("file:///main.rs").unwrap());

pub fn syntax_error( message: impl Into<String>, offset: usize, url: Option<Url>, ) -> Self

Creates a kind error with a message and location.

Arguments

• message - Description of the kind error
• offset - The byte offset where the error occurred
• url - Optional URL of the file that caused the error

Examples

let error = OakError::syntax_error("Unexpected token", 5, None);

pub fn unexpected_character( character: char, offset: usize, url: Option<Url>, ) -> Self

Creates an unexpected character error.

Arguments

• character - The unexpected character
• offset - The byte offset where the character was found
• url - Optional URL of the file that caused the error

Examples

let error = OakError::unexpected_character('$', 0, None);

pub fn unexpected_token( token: impl Into<String>, offset: usize, url: Option<Url>, ) -> Self

Creates an unexpected token error.

pub fn unexpected_eof(offset: usize, url: Option<Url>) -> Self

Creates an unexpected end of file error.

pub fn expected_token( expected: impl Into<String>, offset: usize, url: Option<Url>, ) -> Self

Creates an expected token error.

pub fn expected_name( name_kind: impl Into<String>, offset: usize, url: Option<Url>, ) -> Self

Creates an expected name error.

pub fn trailing_comma_not_allowed(offset: usize, url: Option<Url>) -> Self

Creates a trailing comma not allowed error.

pub fn custom_error(message: impl Into<String>) -> Self

Creates a custom error for user-defined error conditions.with a message.

Arguments

• message - The error message describing what went wrong

Examples

let error = OakError::custom_error("Invalid configuration");

pub fn invalid_theme(message: impl Into<String>) -> Self

Creates an invalid theme error.

pub fn unsupported_format(format: impl Into<String>) -> Self

Creates an unsupported format error.

pub fn color_parse_error(color: impl Into<String>) -> Self

Creates a color parsing error.

pub fn format_error(message: impl Into<String>) -> Self

Creates a formatting error.

pub fn semantic_error(message: impl Into<String>) -> Self

Creates a semantic error.

pub fn protocol_error(message: impl Into<String>) -> Self

Creates a protocol error.

pub fn kind(&self) -> &OakErrorKind

Returns a reference to the error kind.

Returns

A reference to the OakErrorKind enum that categorizes this error.

pub fn with_url(self, url: Url) -> Self

Attach a URL to the error context.

Trait Implementations

impl Clone for OakError

fn clone(&self) -> OakError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OakError

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

Formats the value using the given formatter.

impl Display for OakError

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

Formats the value using the given formatter.

impl Error for OakError

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 OakError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OakError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<OakErrorKind> for OakError

fn from(kind: OakErrorKind) -> Self

Converts to this type from the input type.