This is the fiveam-matchers Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 05:07:31 2025 GMT+0.
fiveam-matchers/fiveam-matchers.asdfiveam-matchers/core.lispfiveam-matchers/delegating.lispfiveam-matchers/described-as.lispfiveam-matchers/every-item.lispfiveam-matchers/lists.lispfiveam-matchers/has-length.lispfiveam-matchers/numbers.lispfiveam-matchers/misc.lispfiveam-matchers/strings.lispfiveam-matchers/satisfying.lispfiveam-matchers/errors.lispfiveam-matchers/all.lispfiveam-matchers/corefiveam-matchers/miscfiveam-matchers/delegatingfiveam-matchers/satisfyingfiveam-matchers/listsfiveam-matchers/has-lengthfiveam-matchers/stringsfiveam-matchers/every-itemfiveam-matchers/described-asfiveam-matchers/errorsfiveam-matchersfiveam-matchers/numbersThe main system appears first, followed by any subsystem dependency.
fiveam-matchersAn extensible matchers library for FiveAM
Arnold Noronha <arnold@tdrhq.com>
Apache License, Version 2.0
0.0.1
fiveam (system).
cl-ppcre (system).
str (system).
core.lisp (file).
delegating.lisp (file).
described-as.lisp (file).
every-item.lisp (file).
lists.lisp (file).
has-length.lisp (file).
numbers.lisp (file).
misc.lisp (file).
strings.lisp (file).
satisfying.lisp (file).
errors.lisp (file).
all.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
fiveam-matchers/fiveam-matchers.asdfiveam-matchers/core.lispfiveam-matchers/delegating.lispfiveam-matchers/described-as.lispfiveam-matchers/every-item.lispfiveam-matchers/lists.lispfiveam-matchers/has-length.lispfiveam-matchers/numbers.lispfiveam-matchers/misc.lispfiveam-matchers/strings.lispfiveam-matchers/satisfying.lispfiveam-matchers/errors.lispfiveam-matchers/all.lispfiveam-matchers/fiveam-matchers.asdfiveam-matchers (system).
fiveam-matchers/core.lispfiveam-matchers (system).
assert-that (macro).
describe-mismatch (generic function).
describe-self (method).
describe-self (method).
describe-self (method).
describe-self (method).
ensure-matcher (function).
equal-to (function).
equal-to (class).
has-all (function).
has-all (class).
has-any (function).
has-any (class).
has-typep (function).
has-typep (class).
is-equal-to (function).
is-not (function).
is-not (class).
matcher (class).
matchesp (generic function).
self-describing-list (function).
self-describing-list (class).
single-value-matcher (class).
call-assert-that (function).
check-matcher-list (function).
describe-mismatch-to-string (method).
describe-self-to-string (method).
does-not (function).
end (reader method).
esc (function).
escaped (class).
format-description (function).
matchers (reader method).
matchers (reader method).
render-description (function).
sep (reader method).
start (reader method).
value (reader method).
value (reader method).
value (reader method).
value (reader method).
fiveam-matchers/delegating.lispcore.lisp (file).
fiveam-matchers (system).
describe-mismatch (method).
describe-self (method).
matchesp (method).
delegate (reader method).
delegating-matcher (class).
fiveam-matchers/described-as.lispdelegating.lisp (file).
fiveam-matchers (system).
described-as (macro).
call-described-as (function).
fiveam-matchers/every-item.lispdescribed-as.lisp (file).
fiveam-matchers (system).
describe-mismatch (method).
describe-self (method).
every-item (function).
every-item (class).
matchesp (method).
expected (reader method).
(setf expected) (writer method).
fiveam-matchers/lists.lispevery-item.lisp (file).
fiveam-matchers (system).
contains (function).
contains (class).
contains-in-any-order (function).
contains-in-any-order (class).
describe-mismatch (method).
describe-mismatch (method).
describe-mismatch (method).
describe-self (method).
describe-self (method).
describe-self (method).
does-not-have-item (function).
has-item (function).
has-item (class).
matchesp (method).
matchesp (method).
matchesp (method).
expected (reader method).
expected (reader method).
expected (reader method).
(setf expected) (writer method).
(setf expected) (writer method).
(setf expected) (writer method).
fiveam-matchers/has-length.lisplists.lisp (file).
fiveam-matchers (system).
describe-mismatch (method).
describe-self (method).
has-length (function).
has-length (class).
matchesp (method).
expected (reader method).
(setf expected) (writer method).
fiveam-matchers/numbers.lisphas-length.lisp (file).
fiveam-matchers (system).
describe-mismatch (method).
describe-self (method).
matchesp (method).
allowed-error (reader method).
expected (reader method).
is-number-close-to (function).
is-number-close-to (class).
fiveam-matchers/misc.lispnumbers.lisp (file).
fiveam-matchers (system).
is-null (function).
is-not-null (function).
fiveam-matchers/strings.lispmisc.lisp (file).
fiveam-matchers (system).
contains-string (method).
describe-mismatch (method).
describe-mismatch (method).
describe-mismatch (method).
describe-self (method).
describe-self (method).
describe-self (method).
is-not-empty (function).
is-string (function).
matches-regex (function).
matchesp (method).
matchesp (method).
matchesp (method).
starts-with (method).
contains-string-matcher (class).
matches-regex-matcher (class).
needle (reader method).
prefix (reader method).
regex (reader method).
starts-with-matcher (class).
fiveam-matchers/satisfying.lispstrings.lisp (file).
fiveam-matchers (system).
describe-mismatch (method).
describe-self (method).
matchesp (method).
expr (reader method).
expr-str (function).
predicate (reader method).
satisfying (macro).
satisfying (class).
fiveam-matchers/errors.lispsatisfying.lisp (file).
fiveam-matchers (system).
describe-self (method).
error-with-string-matching (method).
error-with-string-matching (method).
error-with-string-matching (class).
matchesp (method).
signals-error-matching (macro).
delegate (reader method).
describe-mismatch-to-string (method).
fiveam-matchers/all.lisperrors.lisp (file).
fiveam-matchers (system).
Packages are listed by definition order.
fiveam-matchers/corefiveam-matchers/miscfiveam-matchers/delegatingfiveam-matchers/satisfyingfiveam-matchers/listsfiveam-matchers/has-lengthfiveam-matchers/stringsfiveam-matchers/every-itemfiveam-matchers/described-asfiveam-matchers/errorsfiveam-matchersfiveam-matchers/numbersfiveam-matchers/corealexandria.
common-lisp.
assert-that (macro).
describe-mismatch (generic function).
describe-mismatch (slot).
describe-self (generic function).
describe-self (slot).
ensure-matcher (function).
equal-to (function).
equal-to (class).
has-all (function).
has-all (class).
has-any (function).
has-any (class).
has-typep (function).
has-typep (class).
is-equal-to (function).
is-not (function).
is-not (class).
matcher (class).
matcher (slot).
matchesp (generic function).
self-describing-list (function).
self-describing-list (class).
single-value-matcher (class).
call-assert-that (function).
check-matcher-list (function).
describe-mismatch-to-string (generic function).
describe-self-to-string (generic function).
does-not (function).
end (generic reader).
esc (function).
escaped (class).
format-description (function).
matchers (generic reader).
render-description (function).
sep (generic reader).
start (generic reader).
value (generic reader).
fiveam-matchers/misccommon-lisp.
is-null (function).
is-not-null (function).
fiveam-matchers/delegatingcommon-lisp.
delegate (generic reader).
delegating-matcher (class).
fiveam-matchers/satisfyingcommon-lisp.
expr (generic reader).
expr-str (function).
predicate (generic reader).
satisfying (macro).
satisfying (class).
fiveam-matchers/listsalexandria.
common-lisp.
contains (function).
contains (class).
contains-in-any-order (function).
contains-in-any-order (class).
does-not-have-item (function).
has-item (function).
has-item (class).
expected (generic reader).
(setf expected) (generic writer).
fiveam-matchers/has-lengthcommon-lisp.
fiveam-matchers/core.
has-length (function).
has-length (class).
expected (generic reader).
(setf expected) (generic writer).
fiveam-matchers/stringscommon-lisp.
fiveam-matchers/core.
contains-string (generic function).
is-not-empty (function).
is-string (function).
matches-regex (function).
starts-with (generic function).
contains-string-matcher (class).
matches-regex-matcher (class).
needle (generic reader).
prefix (generic reader).
regex (generic reader).
starts-with-matcher (class).
fiveam-matchers/every-itemcommon-lisp.
fiveam-matchers/core.
every-item (function).
every-item (class).
expected (generic reader).
(setf expected) (generic writer).
fiveam-matchers/described-ascommon-lisp.
described-as (macro).
call-described-as (function).
fiveam-matchers/errorscommon-lisp.
fiveam-matchers/core.
error-with-string-matching (generic function).
error-with-string-matching (class).
signals-error-matching (macro).
delegate (generic reader).
describe-mismatch-to-string (generic function).
fiveam-matchers/numberscommon-lisp.
allowed-error (generic reader).
expected (generic reader).
is-number-close-to (function).
is-number-close-to (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Override the description for a given matcher
Checks if a the expr signaled an error whose string representation
matches the given matchers. Useful for asserting SIMPLE-ERRORs.
If a matcher is just a string, it is treated as equivalent to a regex, i.e. (error-with-string-matching (matches-regex ...)).
Synonym for equal-to
string)) ¶satisfying) value) ¶matches-regex-matcher) actual) ¶contains-string-matcher) actual) ¶starts-with-matcher) actual) ¶is-number-close-to) value) ¶has-length) actual) ¶contains-in-any-order) (actual list)) ¶every-item) actual) ¶delegating-matcher) actual) ¶error-with-string-matching)) ¶satisfying)) ¶matches-regex-matcher)) ¶contains-string-matcher)) ¶starts-with-matcher)) ¶is-number-close-to)) ¶has-length)) ¶contains-in-any-order)) ¶every-item)) ¶delegating-matcher)) ¶error-with-string-matching) value) ¶satisfying) val) ¶matches-regex-matcher) actual) ¶contains-string-matcher) actual) ¶starts-with-matcher) actual) ¶is-number-close-to) value) ¶has-length) actual) ¶contains-in-any-order) (actual list)) ¶Compare against all permutations. Technically, we can use max-flow algorithm to speed this up, but .. meh.
every-item) actual) ¶delegating-matcher) actual) ¶string)) ¶:expected
:expected
:expected
:expected
:expected
is-number-close-to)) ¶automatically generated reader method
delegating-matcher)) ¶automatically generated reader method
error-with-string-matching)) ¶automatically generated reader method
error-with-string-matching) value) ¶self-describing-list)) ¶automatically generated reader method
has-item)) ¶automatically generated reader method
contains-in-any-order)) ¶automatically generated reader method
has-item)) ¶automatically generated writer method
contains-in-any-order)) ¶automatically generated writer method
has-length)) ¶automatically generated reader method
has-length)) ¶automatically generated writer method
every-item)) ¶automatically generated reader method
every-item)) ¶automatically generated writer method
is-number-close-to)) ¶automatically generated reader method
satisfying)) ¶automatically generated reader method
expr.
contains-string-matcher)) ¶automatically generated reader method
satisfying)) ¶automatically generated reader method
starts-with-matcher)) ¶automatically generated reader method
matches-regex-matcher)) ¶automatically generated reader method
self-describing-list)) ¶automatically generated reader method
self-describing-list)) ¶automatically generated reader method
self-describing-list)) ¶automatically generated reader method
single-value-matcher)) ¶automatically generated reader method
Sometimes it’s easier to create a matcher in terms of other matchers, but even in those situations you might want to modify the describe-self and describe-mismatch
:allowed-error
This slot is read-only.
| Jump to: | (
A C D E F G H I M N P R S V |
|---|
| Jump to: | (
A C D E F G H I M N P R S V |
|---|
| Jump to: | A D E M N P R S V |
|---|
| Jump to: | A D E M N P R S V |
|---|
| Jump to: | A C D E F H I L M N P S |
|---|
| Jump to: | A C D E F H I L M N P S |
|---|