pub struct ClassSlot<'class> { /* private fields */ }Expand description
A named slot borrowed from a class, used to inspect its facets and constraints.
Slot queries name the slot on every call, so no index into the class’s slot array is ever retained across a mutation.
Implementations§
Source§impl ClassSlot<'_>
impl ClassSlot<'_>
Sourcepub fn sources(&self) -> Vec<String>
pub fn sources(&self) -> Vec<String>
The classes a slot’s definition comes from, most specific first.
Sourcepub fn facets(&self) -> Vec<String>
pub fn facets(&self) -> Vec<String>
The slot’s facets as CLIPS’s own abbreviations, in its documented order:
field type, storage, propagation, access, sharing, pattern match,
visibility, create-accessor, override message, and source, for example
SGL STC INH R SHR RCT EXC PUB R NIL.
Unlike ClassSlot::is_public, this query does follow inheritance.
Sourcepub fn allowed_types(&self) -> Vec<String>
pub fn allowed_types(&self) -> Vec<String>
The allowed primitive types, or an empty vector when unconstrained.
Examples found in repository?
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}Sourcepub fn allowed_classes(&self) -> Vec<String>
pub fn allowed_classes(&self) -> Vec<String>
The allowed classes, or an empty vector when unconstrained.
Sourcepub fn allowed_values(&self) -> Vec<String>
pub fn allowed_values(&self) -> Vec<String>
The allowed values as their printed forms, or an empty vector when unconstrained.
Sourcepub fn range(&self) -> Option<(String, String)>
pub fn range(&self) -> Option<(String, String)>
The numeric range as (low, high) printed forms, when constrained.
Sourcepub fn cardinality(&self) -> Option<(String, String)>
pub fn cardinality(&self) -> Option<(String, String)>
The multislot cardinality as (minimum, maximum) printed forms. Single
slots have no cardinality and return None.
Sourcepub fn default_type(&self, environment: &Environment) -> SlotDefaultType
pub fn default_type(&self, environment: &Environment) -> SlotDefaultType
Whether the slot has a static default, a dynamic one, or none at all.
Unlike the other queries here, CLIPS resolves this one without following
inheritance, so an inherited slot reports SlotDefaultType::None. Ask
the class named by ClassSlot::sources for the defining class’s
answer.
Sourcepub fn default_value(&self) -> Option<String>
pub fn default_value(&self) -> Option<String>
The slot’s default value as its printed form, when it has one.
Examples found in repository?
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}Sourcepub fn is_writable(&self) -> bool
pub fn is_writable(&self) -> bool
Whether the slot can be written after the instance is created.
Sourcepub fn is_initable(&self) -> bool
pub fn is_initable(&self) -> bool
Whether the slot can be set by make-instance.
Sourcepub fn is_public(&self) -> bool
pub fn is_public(&self) -> bool
Whether subclasses may access the slot directly.
Like ClassSlot::default_type, CLIPS resolves this without following
inheritance, so an inherited slot reports false. Ask the class named
by ClassSlot::sources for the defining class’s answer.
Sourcepub fn has_direct_access(&self) -> bool
pub fn has_direct_access(&self) -> bool
Whether handlers of this class may read the slot without a message.