Struct swipl::atom::LazyAtom

pub struct LazyAtom { /* private fields */ }

A struct which provides a way to delay and cache atom creation.

This struct wraps a static string and uses it to construct a swipl atom on the first invocation of as_atom. Subsequent invocations will reuse the earlier constructed atom.

The purpose of this struct is to back the implementation of the atom! macro, but it’s also usable on its own.

Implementations

impl LazyAtom

pub const fn new(s: &'static str) -> Self

Create a new LazyAtom.

This constructor is const, as all it does is set up the struct. No actual calls into SWI-Prolog happen at this stage.

pub fn as_atom_t(&self) -> atom_t

Trait Implementations

impl AsAtom for LazyAtom

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.