Struct napi::Error

pub struct Error<S: AsRef<str> = Status> {
    pub status: S,
    pub reason: String,
    /* private fields */
}

Represent JsError. Return this Error in js_function, napi-rs will throw it as JsError for you. If you want throw it as TypeError or RangeError, you can use JsTypeError/JsRangeError::from(Error).throw_into(env)

Fields

status: S

reason: String

Implementations

impl<S: AsRef<str>> Error<S>

pub fn new<R: ToString>(status: S, reason: R) -> Self

pub fn from_status(status: S) -> Self

impl Error

pub fn from_reason<T: Into<String>>(reason: T) -> Self

Trait Implementations

impl<S: Clone + AsRef<str>> Clone for Error<S>

fn clone(&self) -> Error<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + AsRef<str>> Debug for Error<S>

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

Formats the value using the given formatter.

impl<S: AsRef<str> + Debug> Display for Error<S>

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

Formats the value using the given formatter.

impl<S: AsRef<str>> Drop for Error<S>

fn drop(&mut self)

Executes the destructor for this type.

impl Error for Error

fn custom<T: Display>(msg: T) -> Self

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

impl<S: AsRef<str> + Debug> Error for Error<S>

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

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, demand: &mut Demand<'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 Error

fn custom<T: Display>(msg: T) -> Self

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<S: AsRef<str>> From<Error<S>> for JsError<S>

fn from(err: Error<S>) -> Self

Converts to this type from the input type.

impl<S: AsRef<str>> From<Error<S>> for JsRangeError<S>

fn from(err: Error<S>) -> Self

Converts to this type from the input type.

impl<S: AsRef<str>> From<Error<S>> for JsSyntaxError<S>

fn from(err: Error<S>) -> Self

Converts to this type from the input type.

impl<S: AsRef<str>> From<Error<S>> for JsTypeError<S>

fn from(err: Error<S>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: SerdeJSONError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl<S: AsRef<str>> From<Infallible> for Error<S>

fn from(_: Infallible) -> Self

Converts to this type from the input type.

impl From<JsUnknown> for Error

fn from(value: JsUnknown) -> Self

Converts to this type from the input type.

impl From<NulError> for Error

fn from(error: NulError) -> Self

Converts to this type from the input type.

impl<S: AsRef<str>> ToNapiValue for Error<S>

unsafe fn to_napi_value(env: napi_env, val: Self) -> Result<napi_value>

Safety

impl<S> Send for Error<S>where S: Send + AsRef<str>,

impl<S> Sync for Error<S>where S: Sync + AsRef<str>,