Struct Error

pub struct Error { /* private fields */ }

Error that implements TryIntoJs and can produce specific error types.

Error implements From for most error types, allowing ergonomic error handling in exported functions with the ? operator.

Example

use neon::types::extract::Error;

#[neon::export]
fn read_file(path: String) -> Result<String, Error> {
    let contents = std::fs::read_to_string(path)?;
    Ok(contents)
}

Implementations

impl Error

pub fn new<E>(cause: E) -> Self

where E: Into<Box<dyn Error + Send + Sync + 'static>>,

Create a new Error from a cause

pub fn range_error<E>(cause: E) -> Self

where E: Into<Box<dyn Error + Send + Sync + 'static>>,

Create a RangeError

pub fn type_error<E>(cause: E) -> Self

where E: Into<Box<dyn Error + Send + Sync + 'static>>,

Create a TypeError

pub fn is_range_error(&self) -> bool

Check if error is a RangeError

pub fn is_type_error(&self) -> bool

Check if error is a TypeError

pub fn cause(&self) -> &Box<dyn Error + Send + Sync + 'static>

Get a reference to the underlying cause

pub fn into_cause(self) -> Box<dyn Error + Send + Sync + 'static>

Extract the std::error::Error cause

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl<E> From<E> for Error

where E: Into<Box<dyn Error + Send + Sync + 'static>>,

fn from(cause: E) -> Self

Converts to this type from the input type.

impl<'cx> TryIntoJs<'cx> for Error

type Value = JsError

The type of JavaScript value that will be created

fn try_into_js(self, cx: &mut Cx<'cx>) -> JsResult<'cx, Self::Value>

Convert self into a JavaScript value