Struct swipl::atom::Atom

pub struct Atom { /* private fields */ }

A wrapper for a prolog atom.

When created, the underlying atom will have its reference count increased. When dropped, the reference count will decrease.

Implementations

impl Atom

pub unsafe fn wrap(atom: atom_t) -> Atom

Wrap an atom_t, which is how the SWI-Prolog fli represents atoms.

Safety

This is unsafe because no check is done to ensure that the atom_t indeed points at a valid atom. The caller will have to ensure that this is the case.

pub fn new(name: &str) -> Atom

Create a new atom from the given string.

This will panic if no prolog engine is active on this thread.

If the atom already exists, this will raise the reference count on that atom and then return the existing atom.

pub fn atom_ptr(&self) -> atom_t

Return the underlying atom_t which SWI-Prolog uses to refer to the atom.

pub fn name(&self) -> String

Retrieve the name of this atom, that is, the string with which it was created.

This will panic if no prolog engine is active on this thread.

Trait Implementations

impl AsAtom for &Atom

fn as_atom(&self) -> Atom

Turn the borrowed object into an Atom.

fn as_atom_ptr(&self) -> (atom_t, Option<Atom>)

Turn the borrowed object into an atom_t, and returns an allocation which will keep this atom_t valid as long as it is not dropped.

impl AsAtom for Atom

fn as_atom(&self) -> Atom

Turn the borrowed object into an Atom.

fn as_atom_ptr(&self) -> (atom_t, Option<Atom>)

Turn the borrowed object into an atom_t, and returns an allocation which will keep this atom_t valid as long as it is not dropped.

impl Clone for Atom

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Atom

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Atom

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for Atom

fn drop(&mut self)

Executes the destructor for this type.

impl From<Atom> for String

fn from(atom: Atom) -> String

Converts to this type from the input type.

impl Hash for Atom

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoAtom for &Atom

fn into_atom(self) -> Atom

Turn this object into an Atom.

impl IntoAtom for Atom

fn into_atom(self) -> Atom

Turn this object into an Atom.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Atom

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TermGetable for Atom

fn get(term: &Term<'_>) -> Option<Self>

Get data from a term reference.

fn name() -> &'static str

Get the name of this data type for use in exception reporting.

impl<'a> TermPutable for Atom

fn put(&self, term: &Term<'_>)

Put data into the term reference.

impl ToString for Atom

fn to_string(&self) -> String

Converts the given value to a String.

impl<'a> Unifiable for Atom

fn unify(&self, term: &Term<'_>) -> bool

Unify this data with the given term reference.

impl Eq for Atom

impl StructuralEq for Atom

impl StructuralPartialEq for Atom