Struct CallEnv 

pub struct CallEnv<'id> { /* private fields */ }

The process-bound environment handed to a NIF call.

Implementations

impl<'id> CallEnv<'id>

pub fn cpu_time(self) -> Result<Tuple<'id>, Raised<'id>>

The current logical CPU’s execution time in erlang:timestamp/0 format (enif_cpu_time). Err(Raised) (badarg) if the OS does not support it.

pub unsafe fn schedule_nif( self, fun_name: &CStr, flags: i32, fp: unsafe extern "C" fn(*mut Env, c_int, *const Term) -> Term, argc: i32, argv: *const Term, ) -> Result<AnyTerm<'id>, Raised<'id>>

Reschedule the current NIF to run fp (enif_schedule_nif). The success value must be returned directly from the NIF; a bad fun_name raises badarg, surfaced as Err(Raised).

Safety

fp must be a valid NIF function pointer; argv must point to argc valid terms.

impl CallEnv<'_>

pub unsafe fn with_raw<R>( raw: *mut Env, f: impl for<'id> FnOnce(CallEnv<'id>) -> R, ) -> R

Enter a NIF call with a freshly branded CallEnv. See the env-kind note above for the brand guarantee.

Safety

raw must be the live env pointer the VM supplied for this call.

impl<'id> CallEnv<'id>

pub fn raise<T>(self, reason: impl Term<'id>) -> Result<T, Raised<'id>>

Raise an exception with reason (enif_raise_exception). Always Err, generic over the success type so it fits any position: return env.raise(reason).

pub fn badarg<T>(self) -> Result<T, Raised<'id>>

Raise a badarg error (enif_make_badarg). Always Err.

pub fn check_raised( self, term: AnyTerm<'id>, ) -> Result<AnyTerm<'id>, Raised<'id>>

If the env has a pending exception, return Err(Raised); otherwise Ok(term) (enif_has_pending_exception). The safe way to call a raw enif function that may raise: pass its result straight through.

Trait Implementations

impl<'id> CallingEnv<'id> for CallEnv<'id>

impl<'id> Clone for CallEnv<'id>

fn clone(&self) -> CallEnv<'id>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id> Copy for CallEnv<'id>

impl<'id> Env<'id> for CallEnv<'id>

fn raw_env(&self) -> *mut Env

The raw *mut enif_ffi::Env pointer this handle wraps.

fn as_any_env(self) -> AnyEnv<'id>

The kind-erased handle terms are built against. Every env kind downcasts to the same AnyEnv for a given brand.

fn term_type(self, term: impl Term<'id>) -> Option<TermType>

The dynamic type of term (enif_term_type). None for a type code this otter build does not recognize (a newer-OTP type).

fn hash(self, algorithm: Hash, term: impl Term<'id>, salt: u64) -> u64

Hash a term (enif_hash). algorithm is Phash2 (portable) or InternalHash (node-local, faster).

fn consume_timeslice(self, percent: i32) -> bool

Tell the scheduler how much of the timeslice this NIF used (enif_consume_timeslice). true if the timeslice is exhausted.

fn is_current_process_alive(self) -> bool

Whether the calling process is still alive (enif_is_current_process_alive).

fn make_unique_integer(self, properties: UniqueInteger) -> Integer<'id>

Create a unique integer (enif_make_unique_integer). properties is a bitmask of UniqueInteger::POSITIVE / MONOTONIC.