Struct SimTest 

pub struct SimTest {
    pub name: Symbol,
    pub lib: Symbol,
    pub expr: Expr,
    pub expected: TestExpected,
    pub subjects: Vec<Symbol>,
    pub expr_codec: Symbol,
    pub expected_codec: Option<Symbol>,
    pub example: bool,
    pub capabilities: Vec<CapabilityName>,
}

Executable test or example: an expression, its expectation, and the codec and capability context it runs in.

Fields

name: Symbol

Name the test is registered under.

lib: Symbol

Lib the test belongs to.

expr: Expr

Expression evaluated when the test runs.

expected: TestExpected

Expectation checked against the result.

subjects: Vec<Symbol>

Symbols the test exercises, for reporting and discovery.

expr_codec: Symbol

Codec the test expression round-trips through before evaluation.

expected_codec: Option<Symbol>

Codec the expected value round-trips through, if any.

example: bool

Whether the test also serves as a documentation example.

capabilities: Vec<CapabilityName>

Capabilities the test requires to run.

Implementations

impl SimTest

pub fn new( name: Symbol, lib: Symbol, expr: Expr, expected: TestExpected, subjects: Vec<Symbol>, ) -> Self

Creates a truthiness-by-default test from its name, lib, expression, expectation, and subjects.

pub fn with_expr_codec(self, codec: Symbol) -> Self

Sets the expression codec and returns the updated test.

pub fn with_expected_codec(self, codec: Symbol) -> Self

Sets the expected-value codec and returns the updated test.

pub fn as_example(self) -> Self

Marks the test as a documentation example and returns it.

pub fn requiring(self, capability: CapabilityName) -> Self

Adds a required capability and returns the updated test.

Trait Implementations

impl Clone for SimTest

fn clone(&self) -> SimTest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Object for SimTest

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 SimTest

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.

impl Test for SimTest

fn symbol(&self) -> Symbol

Symbol naming this test.

fn lib(&self) -> Symbol

Symbol of the library that owns this test.

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

Produces a value describing this test without running it.

fn run(&self, cx: &mut Cx) -> Result<TestReport>

Runs the test and returns its TestReport.