Struct ShapeObject 

pub struct ShapeObject {
    pub symbol: Symbol,
    pub shape: Arc<dyn Shape>,
    pub encoding: Option<ObjectEncoding>,
}

Runtime object wrapping a Shape so it is usable as a first-class value: a callable matcher, a kernel class, and (optionally) a re-encodable constructor expression.

Fields

symbol: Symbol

Symbol naming the wrapped shape.

shape: Arc<dyn Shape>

The wrapped shape engine.

encoding: Option<ObjectEncoding>

Constructor encoding used to round-trip the shape back to an expression.

Implementations

impl ShapeObject

pub fn new(symbol: Symbol, shape: Arc<dyn Shape>) -> Self

Wrap a shape under a symbol with no constructor encoding.

pub fn with_encoding( symbol: Symbol, shape: Arc<dyn Shape>, encoding: ObjectEncoding, ) -> Self

Wrap a shape and record the constructor encoding used to re-encode it.

pub fn describe(&self, cx: &mut Cx) -> Result<ShapeDoc>

Describe the wrapped shape (name and details).

Trait Implementations

impl Callable for ShapeObject

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

Invoke the callable with already-evaluated, checked Args.

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

Invoke the callable on raw, unevaluated argument expressions.

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

Optional shape describing the accepted argument list, for browsing.

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

Optional shape describing the call result, for browsing.

impl Clone for ShapeObject

fn clone(&self) -> ShapeObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Object for ShapeObject

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 ShapeObject

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_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

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

Callable view, if the object can be invoked.

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

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

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

Class view, if the object is a class.

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.

impl ObjectEncode for ShapeObject

fn object_encoding(&self, _cx: &mut Cx) -> Result<ObjectEncoding>

Returns the ObjectEncoding this object should be rendered as.