Struct DeinitEnv 

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

The environment handed to the unload callback.

Implementations

impl DeinitEnv<'_>

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

Enter the unload callback with a freshly branded DeinitEnv.

Safety

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

Trait Implementations

impl<'id> Clone for DeinitEnv<'id>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id> Copy for DeinitEnv<'id>

impl<'id> Env<'id> for DeinitEnv<'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.