Struct swipl::module::Module

pub struct Module { /* private fields */ }

A wrapped fora prolog module.

Implementations

impl Module

pub unsafe fn wrap(module: module_t) -> Self

Wrap a module_t, which is how the SWI-Prolog fli represents modules.

Safety

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

pub fn new<A: IntoAtom>(name: A) -> Self

Create a new module from the given name.

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

pub fn module_ptr(&self) -> module_t

Return the underlying module_t which SWI-Prolog uses to refer to the module.

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

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

Retrieve the name of this module 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 module 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 module as a string.

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

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl PartialEq for Module

fn eq(&self, other: &Module) -> 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 Copy for Module

impl Eq for Module

impl Send for Module

impl StructuralEq for Module

impl StructuralPartialEq for Module

impl Sync for Module