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 kind(&self) -> &OakErrorKind

Gets the kind of this error.

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

Creates a test failure error.

pub fn test_regenerated(path: PathBuf) -> OakError

Creates a test regenerated error.

pub fn io_error(error: Error, source_id: u32) -> OakError

Creates an I/O error with optional Source ID.

Arguments

• error - The underlying I/O error
• source_id - Source ID 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, 1);

pub fn syntax_error( message: impl Into<String>, offset: usize, source_id: Option<u32>, ) -> OakError

Creates a kind error with a message and location.

Arguments

• message - Description of the kind error
• offset - The byte offset where the error occurred
• source_id - Optional source ID 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, source_id: Option<u32>, ) -> OakError

Creates an unexpected character error.

Arguments

• character - The unexpected character
• offset - The byte offset where the character was found
• source_id - Optional source ID 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, source_id: Option<u32>, ) -> OakError

Creates an unexpected token error.

pub fn unexpected_eof(offset: usize, source_id: Option<u32>) -> OakError

Creates an unexpected end of file error.

pub fn expected_token( expected: impl Into<String>, offset: usize, source_id: Option<u32>, ) -> OakError

Creates an expected token error.

pub fn expected_name( name_kind: impl Into<String>, offset: usize, source_id: Option<u32>, ) -> OakError

Creates an expected name error.

pub fn trailing_comma_not_allowed( offset: usize, source_id: Option<u32>, ) -> OakError

Creates a trailing comma not allowed error.

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

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>) -> OakError

Creates an invalid theme error.

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

Creates an unsupported format error.

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

Creates a color parsing error.

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

Creates a formatting error.

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

Creates a semantic error.

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

Creates a protocol error.

pub fn serde_error(message: impl Into<String>) -> OakError

Creates a serde serialization error.

pub fn deserialize_error(message: impl Into<String>) -> OakError

Creates a serde deserialization error.

pub fn xml_error(message: impl Into<String>) -> OakError

Creates an XML error.

pub fn zip_error(message: impl Into<String>) -> OakError

Creates a zip error.

pub fn parse_error(message: impl Into<String>) -> OakError

Creates a parse error.

pub fn internal_error(message: impl Into<String>) -> OakError

Creates an internal error.

pub fn with_source_id(self, source_id: u32) -> OakError

Attach a source ID 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<(), Error>

Formats the value using the given formatter.

impl Display for OakError

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

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 Error for OakError

Available on crate feature serde only.

fn custom<T>(msg: T) -> OakError

where T: Display,

Used when a Serialize implementation encounters any error while serializing a type.

impl Error for OakError

Available on crate feature serde only.

fn custom<T>(msg: T) -> OakError

where T: Display,

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.

impl From<Error> for OakError

fn from(error: Error) -> OakError

Converts to this type from the input type.

impl From<OakErrorKind> for OakError

fn from(kind: OakErrorKind) -> OakError

Converts to this type from the input type.

impl From<ParseFloatError> for OakError

fn from(error: ParseFloatError) -> OakError

Converts to this type from the input type.

impl From<ParseIntError> for OakError

fn from(error: ParseIntError) -> OakError

Converts to this type from the input type.