Liking cljdoc? Tell your friends :D

convex.gen

test.check generators for cells.

`test.check` generators for cells.
raw docstring

addressclj

Address cell.

Address cell.
sourceraw docstring

anyclj

Combines scalar and recursive to produce any CVM cell.

Once in a while, generates a syntax as well.

Combines [[scalar]] and [[recursive]] to produce any CVM cell.

Once in a while, generates a [[syntax]] as well.
sourceraw docstring

any-collclj

Any collection.

Any collection.
sourceraw docstring

any-listclj

Recursive list cell where an item can be any cell.

Recursive list cell where an item can be any cell.
sourceraw docstring

any-mapclj

Recursive hash map cell where an item can be any cell.

Recursive hash map cell where an item can be any cell.
sourceraw docstring

any-setclj

Recursive set cell where an item can be any cell.

Recursive set cell where an item can be any cell.
sourceraw docstring

any-vectorclj

Recursive vector cell where an item can be any cell.

Recursive vector cell where an item can be any cell.
sourceraw docstring

blobclj

(blob)
(blob n)
(blob n-min n-max)

Blob cell.

When length is not given, depends on current test.check size.

Blob cell.

When length is not given, depends on current `test.check` size.
sourceraw docstring

blob-32clj

32-byte blob cell.

Useful for CVM hashes and keys.

32-byte blob cell.

Useful for CVM hashes and keys.
sourceraw docstring

blob-mapclj

(blob-map gen-k gen-v)
(blob-map gen-k gen-v n)
(blob-map gen-k gen-v n-min n-max)

Blob map here item are generated using gen.

Generator for keys must output blob or specialized blob like address.

When length target is not provided, depends on current test.check size.

Blob map here item are generated using `gen`.

Generator for keys must output [[blob]] or specialized blob like [[address]].

When length target is not provided, depends on current `test.check` size.
sourceraw docstring

booleanclj

Boolean cell.

Boolean cell.
sourceraw docstring

byteclj

Byte cell.

Byte cell.
sourceraw docstring

charclj

Char cell between 0 and 255 inclusive.

Char cell between 0 and 255 inclusive.
sourceraw docstring

char-alphanumclj

Like char but alphanumeric, hence always printable.

Like [[char]] but alphanumeric, hence always printable.
sourceraw docstring

doubleclj

Double cell.

Double cell.
sourceraw docstring

double-boundedclj

(double-bounded option+)

Like double but accept a map with :min and :max for setting boundaries.

Both are optional.

Like [[double]] but accept a map with `:min` and `:max` for setting boundaries.

Both are optional.
sourceraw docstring

falsyclj

False or nil.

False or nil.
sourceraw docstring

hex-stringclj

(hex-string)
(hex-string n-byte)
(hex-string n-byte-min n-byte-max)

A hex-string where each byte is written as two hex digits.

A hex-string where each byte is written as two hex digits.
sourceraw docstring

keywordclj

Keyword cell.

Keyword cell.
sourceraw docstring

listclj

(list gen)
(list gen n)
(list gen n-min n-max)

List cell where item are generated using gen.

When length target is not provided, depends on current test.check size.

List cell where item are generated using `gen`.

When length target is not provided, depends on current `test.check` size.
sourceraw docstring

longclj

Long cell.

Long cell.
sourceraw docstring

long-boundedclj

(long-bounded option+)

Like long but accept a map with :min and :max for setting boundaries.

Both are optional.

Like [[long]] but accept a map with `:min` and `:max` for setting boundaries.

Both are optional.
sourceraw docstring

mapclj

(map gen-k gen-v)
(map gen-k gen-v n)
(map gen-k gen-v n-min n-max)

Map cell where item are generated using gen.

When length target is not provided, depends on current test.check size.

Map cell where item are generated using `gen`.

When length target is not provided, depends on current `test.check` size.
sourceraw docstring

nothingclj

Generates nil.

Generates nil.
sourceraw docstring

numberclj

Either double or long.

Either [[double]] or [[long]].
sourceraw docstring

number-boundedclj

(number-bounded option+)

Like number but accept a map with :min and :max for setting boundaries.

Both are optional.

Like [[number]] but accept a map with `:min` and `:max` for setting boundaries.

Both are optional.
sourceraw docstring

quotedclj

(quoted gen)

Wraps the given gen so that the output is wrapped in a quote form.

Wraps the given `gen` so that the output is wrapped in a `quote` form.
sourceraw docstring

recursiveclj

Base generators for recursive collection cells where an item of a collection can be a collection as well.

Leaves are scalar while containers can be:

Produces a scalar in roughly 10% of outputs.

Base generators for recursive collection cells where an item of a collection can be a collection as well.

Leaves are [[scalar]] while containers can be:

- [[blob-map]]
- [[list]]
- [[map]]
- [[set]]
- [[vector]]

Produces a [[scalar]] in roughly 10% of outputs.
sourceraw docstring

scalarclj

Any CVM cell that is not a collection:

This excludes non-CVM cells such as the different transaction types.

Any CVM cell that is not a collection:

 - [[address]]
 - [[blob]]
 - [[boolean]]
 - [[byte]]
 - [[char-alphanum]]
 - [[double]]
 - [[keyword]]
 - [[long]]
 - [[nothing]]
 - [[string-alphanum]]
 - [[symbol]]

This excludes non-CVM cells such as the different transaction types.
sourceraw docstring

setclj

(set gen)
(set gen n)
(set gen n-min n-max)

Set cell where item are generated using gen.

When length target is not provided, depends on current test.check size.

Set cell where item are generated using `gen`.

When length target is not provided, depends on current `test.check` size.
sourceraw docstring

stringclj

(string)
(string n)
(string n-min n-max)

String cell containing char.

String cell containing [[char]].
sourceraw docstring

string-alphanumclj

(string-alphanum)
(string-alphanum n)
(string-alphanum n-min n-max)

String cell containing char-alphanum.

String cell containing [[char-alphanum]].
sourceraw docstring

string-symbolicclj

String that can be used to construct a keyword or a symbol.

String that can be used to construct a keyword or a symbol.
sourceraw docstring

symbolclj

Symbol cell.

Symbol cell.
sourceraw docstring

syntaxclj

(syntax)
(syntax gen-value)
(syntax gen-value gen-meta)

Syntax cell.

By default, gen-value is any and gen-meta is either any-map or nothing.

Syntax cell.

By default, `gen-value` is [[any]] and `gen-meta` is either [[any-map]] or [[nothing]].
sourceraw docstring

truthyclj

Like any but neither false nor nil.

Like `any` but neither false nor nil.
sourceraw docstring

tupleclj

(tuple & generator+)

CVX vector where each of the given generator respectively produces an item.

CVX vector where each of the given generator respectively produces an item.
sourceraw docstring

vectorclj

(vector gen)
(vector gen n)
(vector gen n-min n-max)

Vector cell where item are generated using gen.

When length target is not provided, depends on current test.check size.

Vector cell where item are generated using `gen`.

When length target is not provided, depends on current `test.check` size.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close