Struct TableShape 

pub struct TableShape { /* private fields */ }

Shape for table values or map expressions with named field constraints.

Required fields must be present and accepted by their field shapes. Extra fields are controlled by TableExtraPolicy.

let shape = TableShape::single(
    Symbol::new("ok"),
    Arc::new(ExprKindShape::new(ExprKind::Bool)),
);
let expr = Expr::Map(vec![(Expr::Symbol(Symbol::new("ok")), Expr::Bool(true))]);

assert!(shape.check_expr(&mut cx, &expr).unwrap().accepted);

Implementations

impl TableShape

pub fn single(key: Symbol, shape: Arc<dyn Shape>) -> Self

Build a table shape requiring a single named field, allowing extras.

pub fn new(fields: Vec<TableFieldSpec>, extra: TableExtraPolicy) -> Self

Build a table shape from explicit field specs and an extra-key policy.

pub fn fields(&self) -> &[TableFieldSpec]

Return the field constraints in declaration order.

pub fn extra(&self) -> &TableExtraPolicy

Return the policy applied to keys not listed in the field specs.

Trait Implementations

impl Clone for TableShape

fn clone(&self) -> TableShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Shape for TableShape

fn is_total(&self) -> bool

Whether this shape accepts every input in its domain; false by default.

fn is_effectful(&self) -> bool

Whether matching this shape may run effects; false by default.

fn is_subshape_of( &self, cx: &mut Cx, parent: &dyn Shape, ) -> Result<Option<bool>>

Return a concrete implication answer when this shape owns the semantics.

fn check_value(&self, cx: &mut Cx, value: Value) -> Result<ShapeMatch>

Check a Value against this shape, yielding a ShapeMatch.

fn check_expr(&self, cx: &mut Cx, expr: &Expr) -> Result<ShapeMatch>

Check an Expr against this shape, yielding a ShapeMatch.

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

Produce the human-facing ShapeDoc for this shape.

fn id(&self) -> Option<ShapeId>

Stable ShapeId when this shape has runtime identity, else None.

fn symbol(&self) -> Option<Symbol>

Symbol naming this shape when it has one, else None.

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

Parent shapes for the subshape walk; empty by default.