Struct rustler::types::atom::Atom

pub struct Atom { /* fields omitted */ }

Methods

impl Atom

pub fn as_c_arg(&self) -> NIF_TERM

pub fn to_term<'a>(self, env: Env<'a>) -> Term<'a>

pub fn from_term(term: Term) -> NifResult<Self>

pub fn from_bytes<'a>(env: Env<'a>, bytes: &[u8]) -> NifResult<Atom>

Return the atom whose text representation is bytes, like erlang:binary_to_atom/2.

Errors

Error::BadArg if bytes.len() > 255.

pub fn try_from_bytes<'a>(env: Env<'a>, bytes: &[u8]) -> NifResult<Option<Atom>>

Return the atom whose text representation is bytes, like erlang:binary_to_existing_atom/2, if atom with given text representation exists.

Errors

Error::BadArg if bytes.len() > 255.

pub fn from_str<'a>(env: Env<'a>, string: &str) -> NifResult<Atom>

Return the atom whose text representation is the given string, like erlang:list_to_atom/2.

Errors

Error::BadArg if string contains characters that aren't in Latin-1, or if it's too long. The maximum length is 255 characters.

Trait Implementations

impl Encoder for Atom

fn encode<'a>(&self, env: Env<'a>) -> Term<'a>

impl<'a> Decoder<'a> for Atom

fn decode(term: Term<'a>) -> NifResult<Atom>

impl Copy for Atom

impl PartialEq<Atom> for Atom

fn eq(&self, other: &Atom) -> bool

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

fn ne(&self, other: &Atom) -> bool

This method tests for !=.

impl<'a> PartialEq<Term<'a>> for Atom

fn eq(&self, other: &Term<'a>) -> bool

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

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Sync for Atom

impl Clone for Atom

fn clone(&self) -> Atom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Send for Atom

impl Eq for Atom

impl Debug for Atom

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.