Enum rustler::error::Error

pub enum Error {
    BadArg,
    Atom(&'static str),
    RaiseAtom(&'static str),
    RaiseTerm(Box<dyn Encoder>),
}

Represents usual errors that can happen in a nif. This enables you to return an error from anywhere, even places where you don't have an Env availible.

Variants

BadArg

Returned when the NIF has been called with the wrong number or type of arguments.

Atom(&'static str)

Encodes the string into an atom and returns it from the NIF.

RaiseAtom(&'static str)RaiseTerm(Box<dyn Encoder>)

Methods

impl Error

pub unsafe fn encode<'a>(self, env: Env<'a>) -> Term<'a>

Unsafe

If self is a BadArg, RaiseAtom, or RaiseTerm value, then the term returned from this method must not be used except as the return value from the calling NIF.