Struct rustler::NifTerm [] [src]

pub struct NifTerm<'a> { /* fields omitted */ }

NifTerm is used to represent all erlang terms. Terms are always lifetime limited by a NifEnv.

NifTerm is cloneable and copyable, but it can not exist outside of the lifetime of the NifEnv that owns it.

Methods

impl<'a> NifTerm<'a>
[src]

Atom terms

When the term is an atom, this method will return the string representation of it.

If you only need to test for equality, comparing the terms directly is much faster.

Will return None if the term is not an atom.

impl<'a> NifTerm<'a>
[src]

Binary terms

impl<'a> NifTerm<'a>
[src]

List terms

Returns a new empty list.

Returns an iterator over a list term. See documentation for NifListIterator for more information.

Returns None if the term is not a list.

Returns the length of a list term.

Returns None if the term is not a list.

Elixir equivalent

length(self_term)

Unpacks a single cell at the head of a list term, and returns the result as a tuple of (head, tail).

Returns None if the term is not a list.

Elixir equivalent

[head, tail] = self_term
{head, tail}

Makes a copy of the self list term and reverses it.

Returns Err(NifError::BadArg) if the term is not a list.

Adds head in a list cell with self as tail.

impl<'a> NifTerm<'a>
[src]

Map terms

Constructs a new, empty map term.

Elixir equivalent

%{}

Gets the value corresponding to a key in a map term.

Returns Err(NifError::BadArg) if the term is not a map or if key doesn't exist in the map.

Elixir equivalent

Map.get(self_term, key)

Gets the size of a map term.

Returns Err(NifError::BadArg) if the term is not a map.

Elixir equivalent

map_size(self_term)

Makes a copy of the self map term and sets key to value. If the value already exists, it is overwritten.

Returns Err(NifError::BadArg) if the term is not a map.

Elixir equivalent

Map.put(self_term, key, value)

Makes a copy of the self map term and removes key. If the key doesn't exist, the original map is returned.

Returns Err(NifError::BadArg) if the term is not a map.

Elixir equivalent

Map.delete(self_term, key)

Makes a copy of the self map term where key is set to value.

Returns Err(NifError::BadArg) if the term is not a map of if key doesn't exist.

impl<'a> NifTerm<'a>
[src]

Create a NifTerm from a raw NIF_TERM.

Unsafe

The caller must ensure that env is the environment that inner belongs to, unless inner is an atom term.

This extracts the raw term pointer. It is usually used in order to obtain a type that can be passed to calls into the erlang vm.

Returns a representation of self in the given NifEnv.

If the term is already is in the provided env, it will be directly returned. Otherwise the term will be copied over.

Decodes the NifTerm into type T.

This should be used as the primary method of extracting the value from a NifTerm.

Examples

let term: NifTerm = ...;
let number: i32 = try!(term.decode());

impl<'a> NifTerm<'a>
[src]

Type checks

Returns an enum representing which type the term is. Note that using the individual is_* functions is more efficient for checking a single type.

Trait Implementations

impl<'a> NifEncoder for NifTerm<'a>
[src]

impl<'a> NifDecoder<'a> for NifTerm<'a>
[src]

impl<'a> Clone for NifTerm<'a>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<'a> Copy for NifTerm<'a>
[src]

impl<'a> Debug for NifTerm<'a>
[src]

Formats the value using the given formatter.

impl<'a> PartialEq for NifTerm<'a>
[src]

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

impl<'a> Eq for NifTerm<'a>
[src]

impl<'a> Ord for NifTerm<'a>
[src]

This method returns an Ordering between self and other. Read more

impl<'a> PartialOrd for NifTerm<'a>
[src]

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more