Skip to main content

FunctionCall

Struct FunctionCall 

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

Calls a CLIPS function with typed arguments.

Arguments are passed as real CLIPS values rather than as expression text, so nothing has to be formatted, escaped, or re-parsed. This is also how message sends are built, since CLIPS’s own Send only accepts argument text.

Implementations§

Source§

impl<'env> FunctionCall<'env>

Source

pub fn integer(&mut self, value: i64) -> &mut Self

Appends an integer argument.

Source

pub fn float(&mut self, value: f64) -> &mut Self

Appends a float argument.

Source

pub fn symbol(&mut self, value: &str) -> Result<&mut Self>

Appends a symbol argument.

Source

pub fn string(&mut self, value: &str) -> Result<&mut Self>

Appends a string argument.

Source

pub fn instance_name(&mut self, value: &str) -> Result<&mut Self>

Appends an instance-name argument.

Source

pub fn fact(&mut self, value: &Fact<'env>) -> &mut Self

Appends a fact address as an argument.

Source

pub fn instance(&mut self, value: &Instance<'env>) -> &mut Self

Appends an instance address as an argument.

Source

pub fn multifield(&mut self, value: &Multifield<'env>) -> &mut Self

Appends a multifield argument.

Source

pub fn value(&mut self, value: &Value<'env>) -> Result<&mut Self>

Appends an already existing CLIPS value.

Fails with Error::ForeignEnvironment if value belongs to another environment, since CLIPS atoms are interned per environment.

Source

pub fn pop(&mut self)

Removes the most recently appended argument.

Source

pub fn reset(&mut self)

Discards every appended argument.

Source

pub fn call(&mut self, name: &str) -> Result<Value<'env>>

Calls name with the appended arguments and returns its retained result.

The name may be a built-in function, a deffunction, or a generic function. Arguments are cleared afterwards, so the builder can be reused.

Trait Implementations§

Source§

impl Drop for FunctionCall<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

impl<'env> Freeze for FunctionCall<'env>

§

impl<'env> Unpin for FunctionCall<'env>

§

impl<'env> UnsafeUnpin for FunctionCall<'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.