Index of Public Functions and Variables - spec-alpha2 0.2.177-SNAPSHOT (in development)

This page has an alphabetical index of all the documented functions and variables in spec-alpha2.

Shortcuts:
A B C D E F G H I J K L M
N O P Q R S T U V W X Y Z
Other

A

 abbrev-result                function      clojure.alpha.spec.test Given a check result, returns an abbreviated ...
 alt                          macro         clojure.alpha.spec Takes key+pred pairs, e.g.  (s/alt :even even? :sm...
 and                          macro         clojure.alpha.spec Takes predicate/spec-forms, e.g.  (s/and int? even...
 and-                         macro         clojure.alpha.spec Takes predicate/spec-forms, e.g.  (s/and- (s/cat :...
 any                          function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/any.
 any-printable                function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/any...
 assert                       macro         clojure.alpha.spec spec-checking assert expression. Returns x if x is...
 assert*                      function      clojure.alpha.spec Do not call this directly, use 'assert'..

  

B

 bind                         function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 boolean                      function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/boo...
 bytes                        function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/byt...

  

C

 *coll-check-limit*           dynamic var   clojure.alpha.spec The number of elements validated in a collection s...
 *coll-error-limit*           dynamic var   clojure.alpha.spec The number of errors reported by explain in a coll...
 *compile-asserts*            dynamic var   clojure.alpha.spec If true, compiler will enable spec asserts, which ...
 cat                          macro         clojure.alpha.spec Takes key+pred pairs, e.g.  (s/cat :e even? :o odd...
 cat                          function      clojure.alpha.spec.gen Returns a generator of a sequence catenated fr...
 cats                         macro         clojure.alpha.spec Like s/cat, but constrain to only seqs.
 catv                         macro         clojure.alpha.spec Like s/cat, but constrain to only vectors.
 char                         function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/cha...
 char-alpha                   function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/cha...
 char-alphanumeric            function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/cha...
 char-ascii                   function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/cha...
 check                        function      clojure.alpha.spec.test Run generative tests for spec conformance on ...
 check-asserts                function      clojure.alpha.spec Enable or disable spec asserts that have been comp...
 check-asserts?               function      clojure.alpha.spec Returns the value set by check-asserts..
 check-fn                     function      clojure.alpha.spec.test Runs generative tests for fn f using spec and...
 checkable-syms               function      clojure.alpha.spec.test Given an opts map as per check, returns the s...
 choose                       function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 coll-of                      macro         clojure.alpha.spec Returns a spec for a collection of items satisfyin...
 conform                      function      clojure.alpha.spec Given a spec and a value, returns :clojure.alpha.s...
 conformer                    macro         clojure.alpha.spec takes a predicate function with the semantics of c...
 create-spec                  multimethod   clojure.alpha.spec Create a spec object from an explicated spec map. ...

  

D

 def                          macro         clojure.alpha.spec Given a namespace-qualified keyword or resolvable ...
 defcompop                    macro         clojure.alpha.spec Defines a new composite spec with op-name and args...
 defop                        macro         clojure.alpha.spec Defines a new spec op with op-name defined by the ...
 delay                        macro         clojure.alpha.spec.gen given body that returns a generator, returns a...
 describe                     function      clojure.alpha.spec returns an abbreviated description of the spec as ...
 double                       function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/dou...
 double*                      function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 double-in                    macro         clojure.alpha.spec Specs a 64-bit floating point number. Options:  :i...

  

E

 elements                     function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 enumerate-namespace          function      clojure.alpha.spec.test Given a symbol naming an ns, or a collection ...
 every                        macro         clojure.alpha.spec takes a pred and validates collection elements aga...
 every-kv                     macro         clojure.alpha.spec like 'every' but takes separate key and val preds ...
 exercise                     function      clojure.alpha.spec generates a number (default 10) of values compatib...
 exercise-fn                  function      clojure.alpha.spec exercises the fn named by sym (a symbol) by applyi...
 expand-spec                  multimethod   clojure.alpha.spec Create a symbolic spec map from an explicated spec...
 explain                      function      clojure.alpha.spec Given a spec and a value that fails to conform, pr...
 explain-data                 function      clojure.alpha.spec Given a spec and a value x which ought to conform,...
 explain-out                  function      clojure.alpha.spec Prints explanation data (per 'explain-data') to *o...
 explain-printer              function      clojure.alpha.spec Default printer for explain-data. nil indicates a ...
 explain-str                  function      clojure.alpha.spec Given a spec and a value that fails to conform, re...
 explicate                    function      clojure.alpha.spec Return a fully-qualified form given a namespace na...

  

F

 *fspec-iterations*           dynamic var   clojure.alpha.spec The number of times an anonymous fn specified by f...
 fdef                         macro         clojure.alpha.spec Takes a symbol naming a function, and one or more ...
 fmap                         function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 for-all*                     function      clojure.alpha.spec.gen Dynamically loaded clojure.test.check.properti...
 form                         function      clojure.alpha.spec returns the spec as data.
 frequency                    function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 fspec                        macro         clojure.alpha.spec takes :args :ret and (optional) :fn kwargs whose v...

  

G

 gen                          function      clojure.alpha.spec Given a spec, returns the generator for it, or thr...
 gen-for-name                 function      clojure.alpha.spec.gen Dynamically loads test.check generator named s...
 gen-for-pred                 function      clojure.alpha.spec.gen Given a predicate, returns a built-in generato...
 generate                     function      clojure.alpha.spec.gen Generate a single value using generator..
 get-spec                     function      clojure.alpha.spec Returns spec registered for keyword/symbol/var k, ...

  

H

 hash-map                     function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...

  

I

 inst-in                      macro         clojure.alpha.spec Returns a spec that validates insts in the range f...
 inst-in-range?               function      clojure.alpha.spec Return true if inst at or after start and before e...
 instrument                   function      clojure.alpha.spec.test Instruments the vars named by sym-or-syms, a ...
 instrumentable-syms          function      clojure.alpha.spec.test Given an opts map as per instrument, returns ...
 int                          function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/int.
 int-in                       macro         clojure.alpha.spec Returns a spec that validates fixed precision inte...
 int-in-range?                function      clojure.alpha.spec Return true if start <= val, val < end and val is ...
 invalid?                     function      clojure.alpha.spec tests the validity of a conform return value.

  

J


  

K

 keys                         macro         clojure.alpha.spec Creates and returns a map validating spec. :req an...
 keys*                        macro         clojure.alpha.spec takes the same arguments as spec/keys and returns ...
 keyspecs*                    function      clojure.alpha.spec.protocols Returns map of key to symbolic spec.
 keyword                      function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/key...
 keyword-ns                   function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/key...

  

L

 large-integer                function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/lar...
 large-integer*               function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 list                         function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...

  

M

 map                          function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 map-of                       macro         clojure.alpha.spec Returns a spec for a map whose keys satisfy kpred ...
 merge                        macro         clojure.alpha.spec Takes map-validating specs (e.g. 'keys' specs) and...
 multi-spec                   macro         clojure.alpha.spec Takes the name of a spec/predicate-returning multi...

  

N

 nest                         macro         clojure.alpha.spec takes a regex op and returns a non-regex op that d...
 nilable                      macro         clojure.alpha.spec returns a spec that accepts nil and values satisfy...
 nonconforming                macro         clojure.alpha.spec takes a spec and returns a spec that has the same ...
 not-empty                    function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...

  

O

 one-of                       function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 or                           macro         clojure.alpha.spec Takes key+pred pairs, e.g.  (s/or :even even? :sma...

  

P


  

Q


  

R

 *recursion-limit*            dynamic var   clojure.alpha.spec A soft limit on how many times a branching spec (o...
 ratio                        function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/rat...
 regex?                       function      clojure.alpha.spec returns x if x is a (clojure.spec) regex op, else ...
 register                     function      clojure.alpha.spec Given a namespace-qualified keyword or resolvable ...
 registry                     function      clojure.alpha.spec Returns the registry map, prefer 'get-spec' to loo...
 resolve-fn                   function      clojure.alpha.spec Resolves a symbolic function to a function object ...
 resolve-spec                 function      clojure.alpha.spec Returns a spec object given a fully-qualified spec...
 return                       function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...

  

S

 sample                       function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 scale                        function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 schema                       macro         clojure.alpha.spec Given a literal vector or map schema, expand to a ...
 Schema                       protocol      clojure.alpha.spec.protocols 
 schema*                      function      clojure.alpha.spec Returns a schema object given a fully-qualified sc...
 schema?                      function      clojure.alpha.spec Returns x if x is a schema object, else logical fa...
 select                       macro         clojure.alpha.spec Takes a keyset and a selection pattern and returns...
 Select                       var           clojure.alpha.spec.protocols Marker protocol for selects.
 set                          function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 shuffle                      function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 simple-type                  function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/sim...
 simple-type-printable        function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/sim...
 spec                         macro         clojure.alpha.spec Given a function symbol, set of constants, or anon...
 spec?                        function      clojure.alpha.spec returns x if x is a spec object, else logical fals...
 string                       function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/str...
 string-alphanumeric          function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/str...
 string-ascii                 function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/str...
 such-that                    function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 summarize-results            function      clojure.alpha.spec.test Given a collection of check-results, e.g. fro...
 symbol                       function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/sym...
 symbol-ns                    function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/sym...

  

T

 tuple                        macro         clojure.alpha.spec takes one or more preds and returns a spec for a t...
 tuple                        function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...

  

U

 unform                       function      clojure.alpha.spec Given a spec and a value created by or compliant w...
 union                        macro         clojure.alpha.spec Takes schemas and unions them, returning a schema ...
 unstrument                   function      clojure.alpha.spec.test Undoes instrument on the vars named by sym-or...
 uuid                         function      clojure.alpha.spec.gen Fn returning clojure.test.check.generators/uui...

  

V

 valid?                       function      clojure.alpha.spec Helper function that returns true when x is valid ...
 vector                       function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 vector-distinct              function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...
 vector-distinct-by           function      clojure.alpha.spec.gen Lazy loaded version of clojure.test.check.gene...

  

W

 with-gen                     macro         clojure.alpha.spec Takes a spec and a no-arg, generator-returning fn ...
 with-instrument-disabled     macro         clojure.alpha.spec.test Disables instrument's checking of calls, with...

  

X


  

Y


  

Z


  

Other

 &                            macro         clojure.alpha.spec takes a regex op re, and predicates. Returns a reg...
 *                            macro         clojure.alpha.spec Returns a regex op that matches zero or more value...
 +                            macro         clojure.alpha.spec Returns a regex op that matches one or more values...
 ?                            macro         clojure.alpha.spec Returns a regex op that matches zero or one value ...

  
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.