pub struct Deffunction<'env> { /* private fields */ }Expand description
A handle to one Deffunction construct.
Borrowing the environment is what keeps it sound: undefining a
construct, clearing, or loading a binary image all need
&mut Environment and so cannot run while a handle is alive.
Implementations§
Source§impl Deffunction<'_>
impl Deffunction<'_>
Source§impl Deffunction<'_>
impl Deffunction<'_>
Sourcepub fn module_name(&self) -> &str
pub fn module_name(&self) -> &str
The name of the defmodule this construct belongs to.
Empty if CLIPS reports no module, which the safe API should not be able to produce.
Sourcepub fn pretty_print(&self) -> Option<&str>
pub fn pretty_print(&self) -> Option<&str>
The construct’s source text as CLIPS reformats it.
None when no pretty-print form is stored: CLIPS discards them
for constructs defined while pretty-printing was disabled, and
for everything restored from a binary image.
Sourcepub fn is_deletable(&self) -> bool
pub fn is_deletable(&self) -> bool
Whether the construct can currently be undefined.
CLIPS refuses while the construct is in use, for example a deftemplate with existing facts or a class with instances.
Source§impl Deffunction<'_>
impl Deffunction<'_>
Sourcepub fn arity(&self) -> Option<DeffunctionArity>
pub fn arity(&self) -> Option<DeffunctionArity>
The function’s declared arity.
CLIPS exposes arity only as private struct fields, so it is read back
from the parameter list of the pretty-print form. Returns None when
the deffunction has no pretty-print form, for example after a binary
load that discarded it.