rustler 0.37.3

Safe Rust wrappers for creating Erlang NIF functions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use std::ops::Deref;

use crate::{Decoder, Encoder, Env, Error, NifResult, Term};

use crate::sys::enif_make_ref;

/// Wrapper for BEAM reference terms.
#[derive(PartialEq, Eq, Clone, Copy)]
pub struct Reference<'a>(Term<'a>);

impl Reference<'_> {
    /// Returns a representation of self in the given Env.
    ///
    /// If the term is already is in the provided env, it will be directly returned. Otherwise
    /// the term will be copied over.
    pub fn in_env<'b>(&self, env: Env<'b>) -> Reference<'b> {
        Reference(self.0.in_env(env))
    }
}

impl<'a> Deref for Reference<'a> {
    type Target = Term<'a>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<'a> From<Reference<'a>> for Term<'a> {
    fn from(term: Reference<'a>) -> Self {
        term.0
    }
}

impl<'a> TryFrom<Term<'a>> for Reference<'a> {
    type Error = Error;

    fn try_from(term: Term<'a>) -> Result<Self, Self::Error> {
        if term.is_ref() {
            Ok(Reference(term))
        } else {
            Err(Error::BadArg)
        }
    }
}

impl<'a> Decoder<'a> for Reference<'a> {
    fn decode(term: Term<'a>) -> NifResult<Self> {
        term.try_into()
    }
}

impl Encoder for Reference<'_> {
    fn encode<'b>(&self, env: Env<'b>) -> Term<'b> {
        self.0.encode(env)
    }
}

impl<'a> Env<'a> {
    /// Create a new reference in this environment
    pub fn make_ref(self) -> Reference<'a> {
        unsafe { Reference(Term::new(self, enif_make_ref(self.as_c_arg()))) }
    }
}