Struct NativeClass 

pub struct NativeClass {
    pub id: ClassId,
    pub symbol: Symbol,
    pub constructor: FunctionObject,
    pub read_constructor: Option<FunctionObject>,
    pub instance_shape: Option<Arc<dyn Shape>>,
    pub parent_symbols: Vec<Symbol>,
    pub members: Vec<MemberFunction>,
}

Host-defined class: a constructor, optional shapes, parents, and members implementing the kernel Class and Callable contracts.

Fields

id: ClassId

Stable id assigned to the class.

symbol: Symbol

Symbol the class is registered under.

constructor: FunctionObject

Constructor invoked when the class is called.

read_constructor: Option<FunctionObject>

Constructor used for read-construct literals, if distinct from the call constructor.

instance_shape: Option<Arc<dyn Shape>>

Shape that instances of the class are expected to satisfy.

parent_symbols: Vec<Symbol>

Symbols of the class’s parent classes.

members: Vec<MemberFunction>

Member accessors exposed by the class.

Implementations

impl NativeClass

pub fn new( id: ClassId, symbol: Symbol, constructor: FunctionObject, instance_shape: Option<Arc<dyn Shape>>, member_fields: Vec<Symbol>, ) -> Self

Creates a class with the given id, symbol, constructor, instance shape, and member fields.

pub fn with_read_constructor( self, read_constructor: Option<FunctionObject>, ) -> Self

Sets the read-construct constructor and returns the updated class.

pub fn with_parents(self, parent_symbols: Vec<Symbol>) -> Self

Sets the parent symbols and returns the updated class.

pub fn constructor(&self) -> &FunctionObject

Returns the class’s call constructor.

pub fn member_names(&self) -> impl Iterator<Item = &Symbol>

Iterates over the field names of the class’s members.

pub fn member_functions(&self) -> &[MemberFunction]

Returns the class’s member accessors.

pub fn member_function(&self, field: &Symbol) -> Option<&MemberFunction>

Looks up a member accessor by field name.

pub fn constructor_shape_arc(&self) -> Option<Arc<dyn Shape>>

Builds the combined argument shape covering all constructor cases.

Trait Implementations

impl Callable for NativeClass

fn call(&self, cx: &mut Cx, args: Args) -> Result<Value>

Invoke the callable with already-evaluated, checked Args.

fn browse_args_shape(&self, cx: &mut Cx) -> Result<Option<ShapeRef>>

Optional shape describing the accepted argument list, for browsing.

fn browse_result_shape(&self, cx: &mut Cx) -> Result<Option<ShapeRef>>

Optional shape describing the call result, for browsing.

fn call_exprs(&self, cx: &mut Cx, args: RawArgs) -> Result<Value, Error>

Invoke the callable on raw, unevaluated argument expressions.

impl Class for NativeClass

fn id(&self) -> ClassId

Stable identity of the class.

fn symbol(&self) -> Symbol

Display symbol naming the class.

fn parents(&self, cx: &mut Cx) -> Result<Vec<ClassRef>>

Direct parent classes; the default reports no parents.

fn constructor_shape(&self, cx: &mut Cx) -> Result<ShapeRef>

Shape describing the arguments accepted by the constructor.

fn instance_shape(&self, cx: &mut Cx) -> Result<ShapeRef>

Shape describing instances produced by the class.

fn read_constructor(&self, _cx: &mut Cx) -> Result<Option<ReadConstructorRef>>

Optional read-constructor for decoding instances from data forms.

fn members(&self, cx: &mut Cx) -> Result<TableRef>

Browseable member table of the class.

fn is_subclass_of(&self, cx: &mut Cx, expected: Value) -> Result<bool, Error>

where Self: Sized,

Whether this class is expected or transitively descends from it.

impl Clone for NativeClass

fn clone(&self) -> NativeClass

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Object for NativeClass

fn display(&self, _cx: &mut Cx) -> Result<String>

Render the object as a human-readable display string.

fn as_any(&self) -> &dyn Any

Expose the object for Rust downcasting.

fn header(&self) -> &ObjectHeader

Identity and trust header for the object; defaults to the shared anonymous header.

fn op(&self, _key: &OpKey) -> Option<&dyn Op>

Resolve the operation registered under key, if any.

fn claims( &self, _cx: &mut Cx, _pattern: &ClaimPattern, _sink: &mut dyn ClaimSink, ) -> Result<(), Error>

Emit the object’s claims matching pattern into sink.

fn snapshot(&self, _cx: &mut Cx) -> Result<Option<Datum>, Error>

Optional content-addressable snapshot of the object’s state.

impl ObjectCompat for NativeClass

fn class(&self, cx: &mut Cx) -> Result<ClassRef>

Class object this value belongs to; defaults to nil.

fn as_expr(&self, _cx: &mut Cx) -> Result<Expr>

Expression form of the object; defaults to an opaque extension node.

fn as_table(&self, cx: &mut Cx) -> Result<Value>

Project the object into a table value; the default exposes its display.

fn as_callable(&self) -> Option<&dyn Callable>

Callable view, if the object can be invoked.

fn as_class(&self) -> Option<&dyn Class>

Class view, if the object is a class.

fn as_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

fn as_object_encoder(&self) -> Option<&dyn ObjectEncode>

Object-encoder view, if the object encodes other objects.

fn as_read_constructor(&self) -> Option<&dyn ReadConstructor>

Read-constructor view, if the object decodes data forms.

fn as_number_domain(&self) -> Option<&(dyn NumberDomain + 'static)>

Number-domain view, if the object is a number domain.

fn as_number_value(&self) -> Option<&dyn NumberValue>

Number-value view, if the object is a domain number.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Eval-fabric view, if the object is a distributed eval surface.

fn as_stream(&self) -> Option<&dyn Stream>

Stream view, if the object is a stream.

fn as_sequence(&self) -> Option<&dyn Sequence>

Sequence view, if the object is a sequence.

fn as_thunk(&self) -> Option<&dyn Thunk>

Thunk view, if the object is a deferred computation.

fn as_list(&self) -> Option<&(dyn ListValue + 'static)>

List view, if the object is a list value.

fn as_table_impl(&self) -> Option<&(dyn Table + 'static)>

Table-implementation view, if the object is a table.

fn as_dir(&self) -> Option<&(dyn Dir + 'static)>

Directory view, if the object is a directory.

fn truth(&self, _cx: &mut Cx) -> Result<bool, Error>

Truthiness of the object; defaults to true.

fn publish_shape_satisfaction_claims( &self, _cx: &mut Cx, _shape: &Ref, ) -> Result<bool, Error>

Publish claims asserting that the object satisfies shape; returns whether any were published.