Skip to main content

MessageCall

Struct MessageCall 

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

A message send with typed arguments.

CLIPS’s C Send entry point only accepts arguments as text, so this builds the call through the function-call builder instead, which takes real CLIPS values and needs no argument string to be assembled or parsed.

Implementations§

Source§

impl<'env> MessageCall<'env>

Source

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

Appends an integer argument.

Examples found in repository?
examples/objects_and_messages.rs (line 31)
7fn main() -> Result<(), Error> {
8    let mut environment = Environment::new()?;
9
10    environment.load_str(
11        r#"
12        (defclass ACCOUNT (is-a USER)
13            (slot holder)
14            (slot balance (type INTEGER) (default 0)))
15
16        (defmessage-handler ACCOUNT deposit (?amount)
17            (bind ?self:balance (+ ?self:balance ?amount))
18            ?self:balance)
19
20        (defmessage-handler ACCOUNT describe ()
21            (str-cat (send ?self get-holder) ": " (send ?self get-balance)))
22        "#,
23    )?;
24
25    let account = environment.make_instance("(ada of ACCOUNT (holder Ada) (balance 100))")?;
26    println!(
27        "class: {}",
28        account.class().expect("instance has a class").name()
29    );
30
31    let balance = account.send("deposit")?.integer(250).send()?;
32    println!("after deposit: {:?}", balance.as_i64());
33    drop(balance);
34
35    // A direct slot write bypasses message passing entirely.
36    account.put_integer("balance", 1_000)?;
37
38    let description = account.send("describe")?.send()?;
39    println!("{}", description.as_str().unwrap_or(""));
40    drop(description);
41    drop(account);
42
43    let class = environment.find_defclass("ACCOUNT")?.expect("class exists");
44    for slot in class.slots(false) {
45        let descriptor = class.slot(&slot).expect("slot name has no NUL");
46        if let Some(descriptor) = descriptor {
47            println!(
48                "slot {slot}: types {:?} default {:?}",
49                descriptor.allowed_types(),
50                descriptor.default_value()
51            );
52        }
53    }
54
55    Ok(())
56}
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 existing CLIPS value as an argument.

Fails with Error::ForeignEnvironment if the value belongs to another environment.

Source

pub fn send(&mut self) -> Result<Value<'env>>

Sends the message and returns its retained result.

Examples found in repository?
examples/objects_and_messages.rs (line 31)
7fn main() -> Result<(), Error> {
8    let mut environment = Environment::new()?;
9
10    environment.load_str(
11        r#"
12        (defclass ACCOUNT (is-a USER)
13            (slot holder)
14            (slot balance (type INTEGER) (default 0)))
15
16        (defmessage-handler ACCOUNT deposit (?amount)
17            (bind ?self:balance (+ ?self:balance ?amount))
18            ?self:balance)
19
20        (defmessage-handler ACCOUNT describe ()
21            (str-cat (send ?self get-holder) ": " (send ?self get-balance)))
22        "#,
23    )?;
24
25    let account = environment.make_instance("(ada of ACCOUNT (holder Ada) (balance 100))")?;
26    println!(
27        "class: {}",
28        account.class().expect("instance has a class").name()
29    );
30
31    let balance = account.send("deposit")?.integer(250).send()?;
32    println!("after deposit: {:?}", balance.as_i64());
33    drop(balance);
34
35    // A direct slot write bypasses message passing entirely.
36    account.put_integer("balance", 1_000)?;
37
38    let description = account.send("describe")?.send()?;
39    println!("{}", description.as_str().unwrap_or(""));
40    drop(description);
41    drop(account);
42
43    let class = environment.find_defclass("ACCOUNT")?.expect("class exists");
44    for slot in class.slots(false) {
45        let descriptor = class.slot(&slot).expect("slot name has no NUL");
46        if let Some(descriptor) = descriptor {
47            println!(
48                "slot {slot}: types {:?} default {:?}",
49                descriptor.allowed_types(),
50                descriptor.default_value()
51            );
52        }
53    }
54
55    Ok(())
56}

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

impl<'env> Freeze for MessageCall<'env>

§

impl<'env> Unpin for MessageCall<'env>

§

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