moonbitlang/quickcheck/property

README
U
Arrow
U
ArrowAsync
U
ArrowError
U
Discard
U
Expected
U
Property
U
Testable
V
callback
V
classify
V
collect
V
counterexample
V
filter
V
forall
V
forall_shrink
V
if_fail
V
label
V
map_size
V
property
V
quick_check
V
quick_check_fn
V
quick_check_fn_error
V
quick_check_fn_error_silence
V
quick_check_fn_silence
V
quick_check_silence
V
shrinking

moonbitlang/quickcheck/property does not have a README file

Expected

using @moonbitlang/quickcheck/internal/state { type Expected }

Re-export Expected from internal/state so lower-level property runners can spell run expectations without importing driver internals.

Testable

source

pub(open) trait Testable {
  fn property(Self) -> Property
}

Anything that can be handed to a QuickCheck-style driver.

Implementors turn themselves into a Property, which a driver then evaluates. Built-in instances exist for Bool, Unit, results, optional values, generators, and the Arrow wrappers.

impl Testable for Unit

impl Testable for Bool

impl Testable for Option[P]

impl Testable for Result[P, E]

impl Testable for Generator[P]

impl Testable for SingleResult

Arrow

source

pub(all) struct Arrow[A, B]((A) -> B)

Arrow[A, B] is a newtype wrapper around a pure, total function (A) -> B. Wrapping is what lets the package implement Testable for generated inputs; MoonBit does not allow implementing a trait directly on the bare function type (A) -> B.

impl Testable for Arrow[A, P]

fn[P : Testable, A : @moonbitlang/core/quickcheck.Arbitrary
Arbitrary + @moonbitlang/core/quickcheck/shrink.Shrink
Shrink + @moonbitlang/core/debug.Debug
Debug] property(self : Arrow[A, P]) -> Property

source

Arrow::property

source

fn[P : Testable, A : @moonbitlang/core/quickcheck.Arbitrary
Arbitrary + @moonbitlang/core/quickcheck/shrink.Shrink
Shrink + @moonbitlang/core/debug.Debug
Debug] Arrow::property(self : Arrow[A, P]) -> Property

ArrowAsync

source

pub(all) struct ArrowAsync[A, B](async (A) -> B)

Same role as Arrow, but the wrapped function is async. The type is reserved for async property testing; no Testable impl is wired up yet.

ArrowError

source

pub(all) struct ArrowError[A, B]((A) -> B raise)

Same role as Arrow, but the wrapped function may raise an error. A raised error is converted into a failing property result.

impl Testable for ArrowError[A, P]

fn[P : Testable, A : @moonbitlang/core/quickcheck.Arbitrary
Arbitrary + @moonbitlang/core/quickcheck/shrink.Shrink
Shrink + @moonbitlang/core/debug.Debug
Debug] property(self : ArrowError[A, P]) -> Property

source

Testable for a raising function: wraps raise as a failure by catching the error and turning it into the counter-example reason.

ArrowError::property

source

fn[P : Testable, A : @moonbitlang/core/quickcheck.Arbitrary
Arbitrary + @moonbitlang/core/quickcheck/shrink.Shrink
Shrink + @moonbitlang/core/debug.Debug
Debug] ArrowError::property(self : ArrowError[A, P]) -> Property

Discard

source

type Discard derive(Default)

A property that discards the current test case.

impl Testable for Discard

Discard::default

source

fn Discard::default() -> Discard

Discard::property

source

fn Discard::property(_self : Discard) -> Property

Property

source

type Property

The shape every Testable collapses to before a driver runs it: a generator of a shrink tree of per-run outcomes.

Property wraps @coreqc.Generator[@rose.Rose[SingleResult]], keeping the representation opaque while exposing controlled execution helpers.

impl Testable for Property

Property::callback

source

fn Property::callback(self : Property, cb : @moonbitlang/quickcheck/internal/state.Callback
Callback) -> Property

Method form of callback, useful for chaining property decorators.

Property::classify

source

fn Property::classify(self : Property, cond : Bool, s : String) -> Property

Method form of classify, useful for chaining property decorators.

Property::collect

source

fn[T : Show] Property::collect(self : Property, t : T) -> Property

Method form of collect, useful for chaining property decorators.

Property::counterexample

source

fn Property::counterexample(self : Property, s : String) -> Property

Method form of counterexample, useful for chaining diagnostics.

Property::filter

source

fn Property::filter(self : Property, cond : Bool) -> Property

Method form of filter, useful for chaining property decorators.

Property::if_fail

source

fn Property::if_fail(self : Property, f : () -> Unit) -> Property

Method form of if_fail, useful for chaining property decorators.

Property::label

source

fn Property::label(self : Property, s : String) -> Property

Method form of label, useful for chaining property decorators.

Property::map_size

source

fn Property::map_size(self : Property, f : (Int) -> Int) -> Property

Method form of map_size, useful for chaining property decorators.

Property::property

source

fn Property::property(self : Property) -> Property

Property::run

source

fn Property::run(self : Property, size : Int, random_state : @moonbitlang/core/quickcheck/splitmix.RandomState
RandomState) -> @moonbitlang/quickcheck/internal/rose.Rose
Rose[@moonbitlang/quickcheck/internal/state.SingleResult
SingleResult]

Evaluate a Property with an explicit size and random state. This is the controlled representation boundary used by drivers.

callback

source

fn[P : Testable] callback(p : P, cb : @moonbitlang/quickcheck/internal/state.Callback
Callback) -> Property

Attach a post-test or post-final-failure callback to p.

classify

source

fn[P : Testable] classify(p : P, cond : Bool, s : String) -> Property

Classifies a test case based on a condition.

collect

source

fn[P : Testable, T : Show] collect(p : P, t : T) -> Property

Attaches a rendered value as a label to a test case.

counterexample

source

fn[P : Testable] counterexample(p : P, s : String) -> Property

Adds a string to the counterexample if the property fails.

filter

source

fn[P : Testable] filter(p : P, cond : Bool) -> Property

Filters a property based on a condition.

forall

source

fn[T : Testable, A : @moonbitlang/core/debug.Debug
Debug] forall(gen : @moonbitlang/core/quickcheck.Generator
Generator[A], f : (A) -> T) -> Property

Run with an explicit generator.

forall_shrink

source

fn[T : Testable, A : @moonbitlang/core/debug.Debug
Debug] forall_shrink(gen : @moonbitlang/core/quickcheck.Generator
Generator[A], shrinker : (A) -> Iter[A], f : (A) -> T) -> Property

Run a property with an explicit generator and shrinker.

if_fail

source

fn[P : Testable] if_fail(p : P, f : () -> Unit) -> Property

Adds a callback that is called if the property fails.

label

source

fn[P : Testable] label(p : P, s : String) -> Property

Attaches a label to a test case.

map_size

source

fn[P : Testable] map_size(p : P, f : (Int) -> Int) -> Property

Adjust the size parameter before running p. Equivalent to Gen::scale(f) but lifted to the Testable level.

property

source

fn[P : Testable] property(prop : P) -> Property

Lift any Testable value to a chainable Property.

shrinking

source

fn[P : Testable, T] shrinking(shrinker : (T) -> Iter[T], x0 : T, pf : (T) -> P) -> Property

Manually drive shrinking with a user-supplied shrinker and starting value.

with_run_options

source

fn[P : Testable] with_run_options(prop : P, expect : @moonbitlang/quickcheck/internal/state.Expected
Expected, abort : Bool) -> Property

Attach driver run options to every result produced by prop. Driver packages use this instead of reaching into Property's representation directly.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Expected

#Testable

#Arrow

#Arrow::property

#ArrowAsync

#ArrowError

#ArrowError::property

#Discard

#Discard::default

#Discard::property

#Property

#Property::callback

#Property::classify

#Property::collect

#Property::counterexample

#Property::filter

#Property::if_fail

#Property::label

#Property::map_size

#Property::property

#Property::run

#callback

#classify

#collect

#counterexample

#filter

#forall

#forall_shrink

#if_fail

#label

#map_size

#property

#shrinking

#with_run_options

Source Files

Expected

Testable

Arrow

Arrow::property

ArrowAsync

ArrowError

ArrowError::property

Discard

Discard::default

Discard::property

Property

Property::callback

Property::classify

Property::collect

Property::counterexample

Property::filter

Property::if_fail

Property::label

Property::map_size

Property::property

Property::run

callback

classify

collect

counterexample

filter

forall

forall_shrink

if_fail

label

map_size

property

shrinking

with_run_options