Struct swipl::functor::Functor

pub struct Functor { /* private fields */ }

A wrapper for a prolog functor.

Implementations

impl Functor

pub unsafe fn wrap(functor: functor_t) -> Self

Wrap a functor_t, which is how the SWI-Prolog fli represents functors.

Safety

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

pub fn new<A: IntoAtom>(name: A, arity: u16) -> Functor

Create a new functor from the given name and arity.

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

pub fn functor_ptr(&self) -> functor_t

Return the underlying functor_t which SWI-Prolog uses to refer to the functor.

pub fn with_name<F, R>(&self, func: F) -> R

where F: Fn(&Atom) -> R,

Retrieve the name of this functor as an atom and pass it into the given function.

The atom does not outlive this call, and the reference count is never incremented. This may be slightly faster in some cases than returning the name directly.

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

pub fn name(&self) -> Atom

Retrieve the name of this functor as an atom.

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

pub fn name_string(&self) -> String

Retrieve the name of this functor as a string.

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

pub fn arity(&self) -> u16

Retrieve the arity of this functor.

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

Trait Implementations

impl Clone for Functor

fn clone(&self) -> Functor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Functor

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

Formats the value using the given formatter.

impl PartialEq for Functor

fn eq(&self, other: &Functor) -> 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<'a> TermGetable for Functor

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 Functor

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

Put data into the term reference.

impl<'a> Unifiable for Functor

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

Unify this data with the given term reference.

impl Copy for Functor

impl Eq for Functor

impl StructuralEq for Functor

impl StructuralPartialEq for Functor