Struct CodecRuntime 

pub struct CodecRuntime {
    pub id: CodecId,
    pub symbol: Symbol,
    pub decoder: Option<Arc<dyn Decoder>>,
    pub located_decoder: Option<Arc<dyn LocatedDecoder>>,
    pub tree_decoder: Option<Arc<dyn TreeDecoder>>,
    pub encoder: Option<Arc<dyn Encoder>>,
    pub located_encoder: Option<Arc<dyn LocatedEncoder>>,
    pub tree_encoder: Option<Arc<dyn TreeEncoder>>,
    pub expr_shape: ShapeRef,
    pub options_shape: ShapeRef,
    pub default_decode: CodecDefaultDecode,
}

A registered codec as a runtime object: a symbol-named bundle of optional decode/encode capabilities plus the Shapes and default-decode policy it exposes.

This is the value the kernel hands back from a codec lookup. Each capability is optional; the dispatch methods (decode, encode_located, …) pick the richest implementation present and fall back to the plain forms otherwise, failing closed with a codec error when none is provided.

Fields

id: CodecId

Stable id of this codec.

symbol: Symbol

The symbol the codec is registered and looked up under.

decoder: Option<Arc<dyn Decoder>>

Plain Expr decoder, if the codec can read.

located_decoder: Option<Arc<dyn LocatedDecoder>>

Origin-preserving decoder, if available.

tree_decoder: Option<Arc<dyn TreeDecoder>>

Full-tree (lossless) decoder, if available.

encoder: Option<Arc<dyn Encoder>>

Plain Expr encoder, if the codec can write.

located_encoder: Option<Arc<dyn LocatedEncoder>>

Origin-aware encoder, if available.

tree_encoder: Option<Arc<dyn TreeEncoder>>

Full-tree (lossless) encoder, if available.

expr_shape: ShapeRef

Shape describing the expressions this codec accepts/produces.

options_shape: ShapeRef

Shape describing this codec’s options table.

default_decode: CodecDefaultDecode

How this codec maps a DecodePosition to a DecodeTarget.

Implementations

impl CodecRuntime

pub fn decode(&self, cx: &mut ReadCx<'_>, input: Input) -> Result<Expr>

Decode input with this codec’s plain decoder, erroring if it has none.

pub fn encode(&self, cx: &mut WriteCx<'_>, expr: &Expr) -> Result<Output>

Encode expr with this codec’s plain encoder, erroring if it has none.

pub fn decode_located( &self, cx: &mut ReadCx<'_>, input: Input, source_id: String, ) -> Result<LocatedExpr>

Decode input preserving origin, falling back to decode with no origin when the codec has no LocatedDecoder.

pub fn decode_tree( &self, cx: &mut ReadCx<'_>, input: Input, source_id: String, ) -> Result<LocatedExprTree>

Decode input into a full tree, falling back to decode_located reconstructed recursively when the codec has no TreeDecoder.

pub fn encode_located( &self, cx: &mut WriteCx<'_>, expr: &LocatedExpr, ) -> Result<Output>

Encode a LocatedExpr, using the origin-aware encoder only when lossless-origin output is requested; otherwise drop the origin and use encode.

pub fn encode_tree( &self, cx: &mut WriteCx<'_>, expr: &LocatedExprTree, ) -> Result<Output>

Encode a LocatedExprTree, preferring the tree encoder then the located encoder for lossless-origin output, and otherwise dropping to encode on the bare expression.

Trait Implementations

impl Object for CodecRuntime

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 CodecRuntime

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.