Skip to main content

Defrule

Struct Defrule 

Source
pub struct Defrule<'env> { /* private fields */ }
Expand description

A handle to one Defrule 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 Defrule<'_>

Source

pub fn name(&self) -> &str

The construct’s name, without any module prefix.

Source§

impl Defrule<'_>

Source

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.

Source

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.

Source

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 Defrule<'_>

Source

pub fn matches(&self, verbosity: Verbosity) -> MatchSummary

Summarises the rule’s matches without exposing any rete structures.

verbosity only controls what CLIPS prints to the routers while computing the summary; the returned counts are the same either way.

Source

pub fn disjuncts(&self) -> Vec<Defrule<'_>>

The rule’s disjuncts, that is, the separate rules CLIPS generates for an or conditional element. A rule without or has exactly one disjunct.

Source§

impl Defrule<'_>

Source

pub fn has_breakpoint(&self) -> bool

Whether a run stops before firing this rule.

Source

pub fn watch_firings(&self) -> bool

Whether CLIPS traces this rule’s firings.

Source

pub fn set_watch_firings(&mut self, enabled: bool)

Enables or disables tracing of this rule’s firings.

Source

pub fn watch_activations(&self) -> bool

Whether CLIPS traces this rule’s activations and deactivations.

Source

pub fn set_watch_activations(&mut self, enabled: bool)

Enables or disables tracing of this rule’s activations.

Auto Trait Implementations§

§

impl<'env> !RefUnwindSafe for Defrule<'env>

§

impl<'env> !Send for Defrule<'env>

§

impl<'env> !Sync for Defrule<'env>

§

impl<'env> !UnwindSafe for Defrule<'env>

§

impl<'env> Freeze for Defrule<'env>

§

impl<'env> Unpin for Defrule<'env>

§

impl<'env> UnsafeUnpin for Defrule<'env>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.