Struct glsp_engine::Class

pub struct Class { /* fields omitted */ }

The class primitive type.

Note that CallableOps is implemented for Root<Class>, so an Obj can be constructed from a Class using glsp::call.

Classes are always stored on the garbage-collected heap, so they're normally represented by the type Root<Class>.

Implementations

impl Class

pub fn get<S: ToSym, V: FromVal>(&self, key: S) -> GResult<V>

Accesses the value of a constant.

Equivalent to [cls key].

pub fn get_if_present<S: ToSym, V: FromVal>(&self, key: S) -> GResult<Option<V>>

Accesses the value of a constant if it's defined.

Equivalent to [cls (? key)].

pub fn call<S, A, R>(&self, key: S, args: A) -> GResult<R> where
    S: ToSym,
    A: IntoCallArgs,
    R: FromVal, 

Invokes a callable value stored in a constant.

Note that the args are passed by reference. They should be a reference to (), a tuple, a slice, or a fixed-size array.

Equivalent to (call-met key cls ..args).

pub fn call_if_present<S, A, R>(&self, key: S, args: A) -> GResult<Option<R>> where
    S: ToSym,
    A: IntoCallArgs,
    R: FromVal, 

If a constant with the given name is defined, and if it stores a callable value, invokes it as a function and returns its result. Otherwise, returns None.

Note that the args are passed by reference. They should be a reference to (), a tuple, a slice, or a fixed-size array.

Equivalent to (call-met (? key) cls ..args).

pub fn has_met<S: ToSym>(&self, key: S) -> GResult<bool>

Returns true if the given name is bound to a constant with a callable value.

Equivalent to (has-met? cls key).

pub fn access_giter(class: &Root<Class>, giter: &Root<GIter>) -> Root<GIter>

Creates an indexing iterator for this collection.

Equivalent to [cls iter].

pub fn has<S: ToSym>(&self, key: S) -> GResult<bool>

Returns true if the given name is bound to a constant.

Equivalent to (has? cls key).

pub fn name(&self) -> Option<Sym>

Returns the name of the class, if any.

Equivalent to (class-name cls).

pub fn has_state<S: ToSym>(&self, state_name: S) -> GResult<bool>

Returns true if the class defines a state with the given name.

Equivalent to (has-state? cls state-name).

pub fn has_mixin(&self, mixin: &Root<Class>) -> bool

Returns true if the class incorporated the given class as a mixin.

Equivalent to (class-has-mixin? cls mixin).

pub fn is_mixin(&self) -> bool

Returns true if the class is a mixin.

Equivalent to (mixin? cls).

pub fn mixins(&self) -> Root<Arr>

Returns all of the class' mixins, as an Arr.

Equivalent to (class-mixins cls).

Trait Implementations

impl Debug for Class

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Class

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.