Struct rustler::Term [−][src]
pub struct Term<'a> { /* fields omitted */ }
Term is used to represent all erlang terms. Terms are always lifetime limited by a Env.
Term is cloneable and copyable, but it can not exist outside of the lifetime of the Env that owns it.
Methods
impl<'a> Term<'a>
[src]
impl<'a> Term<'a>
pub fn atom_to_string(&self) -> NifResult<String>
[src]
pub fn atom_to_string(&self) -> NifResult<String>
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> Term<'a>
[src]
impl<'a> Term<'a>
pub fn into_binary(self) -> NifResult<Binary<'a>>
[src]
pub fn into_binary(self) -> NifResult<Binary<'a>>
impl<'a> Term<'a>
[src]
impl<'a> Term<'a>
pub fn list_new_empty(env: Env<'a>) -> Term<'a>
[src]
pub fn list_new_empty(env: Env<'a>) -> Term<'a>
Returns a new empty list.
pub fn into_list_iterator(self) -> NifResult<ListIterator<'a>>
[src]
pub fn into_list_iterator(self) -> NifResult<ListIterator<'a>>
Returns an iterator over a list term. See documentation for ListIterator for more information.
Returns None if the term is not a list.
pub fn list_length(self) -> NifResult<usize>
[src]
pub fn list_length(self) -> NifResult<usize>
Returns the length of a list term.
Returns None if the term is not a list.
Elixir equivalent
length(self_term)
pub fn list_get_cell(self) -> NifResult<(Term<'a>, Term<'a>)>
[src]
pub fn list_get_cell(self) -> NifResult<(Term<'a>, Term<'a>)>
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}
pub fn list_reverse(self) -> NifResult<Term<'a>>
[src]
pub fn list_reverse(self) -> NifResult<Term<'a>>
Makes a copy of the self list term and reverses it.
Returns Err(Error::BadArg) if the term is not a list.
pub fn list_prepend(self, head: Term<'a>) -> Term<'a>
[src]
pub fn list_prepend(self, head: Term<'a>) -> Term<'a>
Adds head
in a list cell with self
as tail.
impl<'a> Term<'a>
[src]
impl<'a> Term<'a>
pub fn map_new(env: Env<'a>) -> Term<'a>
[src]
pub fn map_new(env: Env<'a>) -> Term<'a>
pub fn map_get(self, key: Term) -> NifResult<Term<'a>>
[src]
pub fn map_get(self, key: Term) -> NifResult<Term<'a>>
Gets the value corresponding to a key in a map term.
Returns Err(Error::BadArg) if the term is not a map or if key doesn't exist in the map.
Elixir equivalent
Map.get(self_term, key)
pub fn map_size(self) -> NifResult<usize>
[src]
pub fn map_size(self) -> NifResult<usize>
Gets the size of a map term.
Returns Err(Error::BadArg) if the term is not a map.
Elixir equivalent
map_size(self_term)
pub fn map_put(self, key: Term<'a>, value: Term<'a>) -> NifResult<Term<'a>>
[src]
pub fn map_put(self, key: Term<'a>, value: Term<'a>) -> NifResult<Term<'a>>
Makes a copy of the self map term and sets key to value. If the value already exists, it is overwritten.
Returns Err(Error::BadArg) if the term is not a map.
Elixir equivalent
Map.put(self_term, key, value)
pub fn map_remove(self, key: Term<'a>) -> NifResult<Term<'a>>
[src]
pub fn map_remove(self, key: Term<'a>) -> NifResult<Term<'a>>
Makes a copy of the self map term and removes key. If the key doesn't exist, the original map is returned.
Returns Err(Error::BadArg) if the term is not a map.
Elixir equivalent
Map.delete(self_term, key)
pub fn map_update(
self,
key: Term<'a>,
new_value: Term<'a>
) -> NifResult<Term<'a>>
[src]
pub fn map_update(
self,
key: Term<'a>,
new_value: Term<'a>
) -> NifResult<Term<'a>>
Makes a copy of the self map term where key is set to value.
Returns Err(Error::BadArg) if the term is not a map of if key doesn't exist.
impl<'a> Term<'a>
[src]
impl<'a> Term<'a>
pub unsafe fn new(env: Env<'a>, inner: NIF_TERM) -> Self
[src]
pub unsafe fn new(env: Env<'a>, inner: NIF_TERM) -> Self
Create a Term
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.
pub fn as_c_arg(&self) -> NIF_TERM
[src]
pub fn as_c_arg(&self) -> NIF_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.
pub fn get_env(&self) -> Env<'a>
[src]
pub fn get_env(&self) -> Env<'a>
pub fn in_env<'b>(&self, env: Env<'b>) -> Term<'b>
[src]
pub fn in_env<'b>(&self, env: Env<'b>) -> Term<'b>
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 decode<T>(self) -> NifResult<T> where
T: Decoder<'a>,
[src]
pub fn decode<T>(self) -> NifResult<T> where
T: Decoder<'a>,
Decodes the Term into type T.
This should be used as the primary method of extracting the value from a Term.
Examples
let term: Term = ...; let number: i32 = try!(term.decode());
pub fn to_binary(self) -> OwnedBinary
[src]
pub fn to_binary(self) -> OwnedBinary
impl<'a> Term<'a>
[src]
impl<'a> Term<'a>
pub fn get_type(self) -> TermType
[src]
pub fn get_type(self) -> TermType
Returns an enum representing which type the term is.
Note that using the individual is_*
functions is more
efficient for checking a single type.
pub fn is_atom(self) -> bool
[src]
pub fn is_atom(self) -> bool
pub fn is_binary(self) -> bool
[src]
pub fn is_binary(self) -> bool
pub fn is_empty_list(self) -> bool
[src]
pub fn is_empty_list(self) -> bool
pub fn is_exception(self) -> bool
[src]
pub fn is_exception(self) -> bool
pub fn is_fun(self) -> bool
[src]
pub fn is_fun(self) -> bool
pub fn is_list(self) -> bool
[src]
pub fn is_list(self) -> bool
pub fn is_map(self) -> bool
[src]
pub fn is_map(self) -> bool
pub fn is_number(self) -> bool
[src]
pub fn is_number(self) -> bool
pub fn is_pid(self) -> bool
[src]
pub fn is_pid(self) -> bool
pub fn is_port(self) -> bool
[src]
pub fn is_port(self) -> bool
pub fn is_ref(self) -> bool
[src]
pub fn is_ref(self) -> bool
pub fn is_tuple(self) -> bool
[src]
pub fn is_tuple(self) -> bool
Trait Implementations
impl<'a> PartialEq<Term<'a>> for Atom
[src]
impl<'a> PartialEq<Term<'a>> for Atom
fn eq(&self, other: &Term<'a>) -> bool
[src]
fn eq(&self, other: &Term<'a>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> Encoder for Term<'a>
[src]
impl<'a> Encoder for Term<'a>
impl<'a> Decoder<'a> for Term<'a>
[src]
impl<'a> Decoder<'a> for Term<'a>
impl<'a> Clone for Term<'a>
[src]
impl<'a> Clone for Term<'a>
fn clone(&self) -> Term<'a>
[src]
fn clone(&self) -> Term<'a>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<'a> Copy for Term<'a>
[src]
impl<'a> Copy for Term<'a>
impl<'a> Debug for Term<'a>
[src]
impl<'a> Debug for Term<'a>
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<'a> PartialEq for Term<'a>
[src]
impl<'a> PartialEq for Term<'a>
fn eq(&self, other: &Term) -> bool
[src]
fn eq(&self, other: &Term) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> Eq for Term<'a>
[src]
impl<'a> Eq for Term<'a>
impl<'a> Ord for Term<'a>
[src]
impl<'a> Ord for Term<'a>
fn cmp(&self, other: &Term) -> Ordering
[src]
fn cmp(&self, other: &Term) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl<'a> PartialOrd for Term<'a>
[src]
impl<'a> PartialOrd for Term<'a>
fn partial_cmp(&self, other: &Term<'a>) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Term<'a>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
1.0.0[src]
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl<'a> Sync for Term<'a>
[src]
impl<'a> Sync for Term<'a>
impl<'a> Send for Term<'a>
[src]
impl<'a> Send for Term<'a>