Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The clavier Reference Manual
This is the clavier Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:11:45 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The clavier Reference Manual, Up: The clavier Reference Manual [Contents][Index]
1 Introduction
Clavier
Clavier is a general purpose validation library for Common Lisp.
Install
Through Quicklisp:
(ql:quickload :clavier)
Getting started
Validators are class instances that validate the arguments passed to the validate function:
(let ((validator (make-instance 'equal-to-validator :object 22)))
(validate validator 22 :error-p t))
;=> T
If the validator succeeds, the validate function returns T. If it fails, the validate function either signals a validation error, or returns NIL and a validation message depending on the value of the :error-p argument.
(let ((validator (make-instance 'equal-to-validator :object 22)))
(validate validator 33 :error-p nil))
;=>
;NIL
;"33 is not equal to 22"
Validators are implemented as funcallable classes. So, alternatively to using the validate function, it is possible to just funcall the validator, like this:
(let ((validator (make-instance 'equal-to-validator :object 22)))
(funcall validator 22 :error-p t))
;=> T
Validation expressions
It is possible to create validators with a more convenient syntax. Each validator provides a builder function. For instance, and equal-to-validator can be built like this:
(funcall (== 100) 100) ;=> T
(funcall (== 100) 99) ;=> NIL
Validators composition
This allows to compose validators, using ==, ~=, &&, || as the composition operands:
(let ((validator (|| (&& (greater-than 20)
(less-than 30))
(|| (&& (greater-than 1)
(less-than 10))
(== 100)))))
(funcall validator 5))
Validators messages
Validators messages to be used when validation fails can be customized passing an :message argument when building the validator
Catching and collecting validation errors
Validation errors can controlled globally by setting the dynamic variable *signal-validation-errors*, which is NIL by default (no validation errors are signaled by default).
There's also the with-signal-validation-errors macro to specify whether validation errors should be signaled or not in a dynamic extent. For instance, this code signals a validation error:
(let ((validator (make-instance 'equal-to-validator :object 22)))
(with-signal-validation-errors (t)
(validate validator 33)))
Use the collecting-validation-errors macro to collect validation errors happening in a dynamic extent:
(let ((validator (make-instance 'equal-to-validator :object 22)))
(collecting-validation-errors (errors found-p)
(progn
(funcall validator 33 :error-p t)
(funcall validator 44 :error-p t))
(print errors)
(print found-p)))
;=>
;(#<VALIDATION-ERROR 44: 44 is not equal to 22 {1008A48673}>
; #<VALIDATION-ERROR 33: 33 is not equal to 22 {1008A47EA3}>)
;T
Validators list:
- equal-to-validator
- not-equal-to-validator
- blank-validator
- not-blank-validator
- true-validator
- false-validator
- type-validator
- string-validator
- boolean-validator
- integer-validator
- symbol-validator
- keyword-validator
- function-validator
- email-validator
- regex-validator
- url-validator
- not-validator
- and-validator
- or-validator
- one-of-validator
- less-than-validator
- greater-than-validator
- length-validator
Next: Files, Previous: Introduction, Up: The clavier Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 clavier
Clavier: A Common Lisp validation library
- Author
Mariano Montone
- Home Page
- License
MIT
- Long Description
Clavier
———-
[](http://quickdocs.org/clavier/)
[](./LICENSE)
*Clavier* is a general purpose validation library for Common Lisp.
Install
——-
Through Quicklisp:
“‘lisp
(ql:quickload :clavier)
“‘
Getting started
—————
Validators are class instances that validate the arguments passed to the ‘validate‘ function:
“‘lisp
(let ((validator (make-instance ’equal-to-validator :object 22)))
(validate validator 22 :error-p t))
;=> T
“‘
If the validator succeeds, the validate function returns ‘T‘. If it fails, the validate function either signals a validation error, or returns ‘NIL‘ and a validation message depending on the value of the ‘:error-p‘ argument.
“‘lisp
(let ((validator (make-instance ’equal-to-validator :object 22)))
(validate validator 33 :error-p nil))
;=>
;NIL
;"33 is not equal to 22"
“‘
Validators are implemented as funcallable classes. So, alternatively to using the ‘validate‘ function, it is possible to just funcall the validator, like this:
“‘lisp
(let ((validator (make-instance ’equal-to-validator :object 22)))
(funcall validator 22 :error-p t))
;=> T
“‘
## Validation expressions
It is possible to create validators with a more convenient syntax. Each validator provides a builder function. For instance, and equal-to-validator can be built like this:
“‘lisp
(funcall (== 100) 100) ;=> T
(funcall (== 100) 99) ;=> NIL
“‘
## Validators composition
This allows to compose validators, using ‘==‘, ‘~=‘, ‘&&‘, ‘||‘ as the composition operands:
“‘lisp
(let ((validator (|| (&& (greater-than 20)
(less-than 30))
(|| (&& (greater-than 1)
(less-than 10))
(== 100)))))
(funcall validator 5))
“‘
## Validators messages
Validators messages to be used when validation fails can be customized passing an ‘:message‘ argument when building the validator
## Catching and collecting validation errors
Validation errors can controlled globally by setting the dynamic variable ‘*signal-validation-errors*‘, which is ‘NIL‘ by default (no validation errors are signaled by default).
There’s also the ‘with-signal-validation-errors‘ macro to specify whether validation errors should be signaled or not in a dynamic extent. For instance, this code signals a validation error:
“‘lisp
(let ((validator (make-instance ’equal-to-validator :object 22)))
(with-signal-validation-errors (t)
(validate validator 33)))
“‘
Use the ‘collecting-validation-errors‘ macro to collect validation errors happening in a dynamic extent:
“‘lisp
(let ((validator (make-instance ’equal-to-validator :object 22)))
(collecting-validation-errors (errors found-p)
(progn
(funcall validator 33 :error-p t)
(funcall validator 44 :error-p t))
(print errors)
(print found-p)))
;=>
;(#<VALIDATION-ERROR 44: 44 is not equal to 22 {1008A48673}>
; #<VALIDATION-ERROR 33: 33 is not equal to 22 {1008A47EA3}>)
;T
“‘
## Validators list:
* equal-to-validator
* not-equal-to-validator
* blank-validator
* not-blank-validator
* true-validator
* false-validator
* type-validator
* string-validator
* boolean-validator
* integer-validator
* symbol-validator
* keyword-validator
* function-validator
* email-validator
* regex-validator
* url-validator
* not-validator
* and-validator
* or-validator
* one-of-validator
* less-than-validator
* greater-than-validator
* length-validator- Dependencies
- alexandria (system).
- cl-ppcre (system).
- closer-mop (system).
- chronicity (system).
- cl-fad (system).
- Source
- Child Components
- package.lisp (file).
- clavier.lisp (file).
Next: Packages, Previous: Systems, Up: The clavier Reference Manual [Contents][Index]
3 Files
Files are sorted by type and then listed depth-first from the systems components trees.
3.1 Lisp
Next: clavier/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
3.1.1 clavier/clavier.asd
- Source
- Parent Component
clavier (system).
- ASDF Systems
Next: clavier/clavier.lisp, Previous: clavier/clavier.asd, Up: Lisp [Contents][Index]
3.1.2 clavier/package.lisp
- Source
- Parent Component
clavier (system).
- Packages
Previous: clavier/package.lisp, Up: Lisp [Contents][Index]
3.1.3 clavier/clavier.lisp
- Dependency
package.lisp (file).
- Source
- Parent Component
clavier (system).
- Public Interface
- ∅ (function).
- && (function).
- *signal-validation-errors* (special variable).
- == (function).
- and-validator (class).
- blank (function).
- blank-validator (class).
- boolean-validator (class).
- call-with-signal-validation-errors (function).
- collecting-validation-errors (macro).
- datetime-validator (class).
- email-validator (class).
- equal-to-validator (class).
- false-validator (class).
- fn (function).
- function-validator (class).
- greater-than (function).
- greater-than-validator (class).
- initialize-instance (method).
- integer-validator (class).
- is-a (function).
- is-a-boolean (function).
- is-a-keyword (function).
- is-a-list (function).
- is-a-string (function).
- is-a-symbol (function).
- is-an-integer (function).
- is-false (function).
- is-true (function).
- keyword-validator (class).
- len (function).
- length-validator (class).
- less-than (function).
- less-than-validator (class).
- list-validator (class).
- matches-regex (function).
- message (reader method).
- (setf message) (writer method).
- not-blank (function).
- not-blank-validator (class).
- not-equal-to-validator (class).
- not-validator (class).
- one-of (function).
- one-of-validator (class).
- or-validator (class).
- pathname-validator (class).
- print-object (method).
- regex-validator (class).
- string-validator (class).
- symbol-validator (class).
- true-validator (class).
- type-validator (class).
- url-validator (class).
- valid-datetime (function).
- valid-email (function).
- valid-pathname (function).
- valid-url (function).
- validate (function).
- validation-error (function).
- validation-error (condition).
- validation-error-message (reader method).
- validation-error-target (reader method).
- validator (reader method).
- (setf validator) (writer method).
- validator (class).
- validator-collection (class).
- validator-message (function).
- with-signal-validation-errors (macro).
- ~ (function).
- ~= (function).
- Internals
- %collecting-validation-errors (function).
- %validate (generic function).
- absolute-p (reader method).
- (setf absolute-p) (writer method).
- object (reader method).
- object (reader method).
- (setf object) (writer method).
- (setf object) (writer method).
- options (reader method).
- (setf options) (writer method).
- pathname-type* (reader method).
- (setf pathname-type*) (writer method).
- probe-p (reader method).
- (setf probe-p) (writer method).
- valid-email-address-p (function).
- valid-url-p (function).
- validator-function (reader method).
- (setf validator-function) (writer method).
- validator-max (reader method).
- (setf validator-max) (writer method).
- validator-max-message (reader method).
- (setf validator-max-message) (writer method).
- validator-min (reader method).
- (setf validator-min) (writer method).
- validator-min-message (reader method).
- (setf validator-min-message) (writer method).
- validator-number (reader method).
- validator-number (reader method).
- (setf validator-number) (writer method).
- (setf validator-number) (writer method).
- validator-regex (reader method).
- (setf validator-regex) (writer method).
- validator-type (reader method).
- (setf validator-type) (writer method).
- validators (reader method).
- (setf validators) (writer method).
- x (reader method).
- x (reader method).
- (setf x) (writer method).
- (setf x) (writer method).
- y (reader method).
- y (reader method).
- (setf y) (writer method).
- (setf y) (writer method).
Next: Definitions, Previous: Files, Up: The clavier Reference Manual [Contents][Index]
4 Packages
Packages are listed by definition order.
4.1 clavier
- Source
- Use List
common-lisp.
- Public Interface
- ∅ (function).
- && (function).
- *signal-validation-errors* (special variable).
- == (function).
- and-validator (class).
- blank (function).
- blank-validator (class).
- boolean-validator (class).
- call-with-signal-validation-errors (function).
- collecting-validation-errors (macro).
- datetime-validator (class).
- email-validator (class).
- equal-to-validator (class).
- false-validator (class).
- fn (function).
- function-validator (class).
- greater-than (function).
- greater-than-validator (class).
- integer-validator (class).
- is-a (function).
- is-a-boolean (function).
- is-a-keyword (function).
- is-a-list (function).
- is-a-string (function).
- is-a-symbol (function).
- is-an-integer (function).
- is-false (function).
- is-true (function).
- keyword-validator (class).
- len (function).
- length-validator (class).
- less-than (function).
- less-than-validator (class).
- list-validator (class).
- matches-regex (function).
- message (generic reader).
- (setf message) (generic writer).
- not-blank (function).
- not-blank-validator (class).
- not-equal-to-validator (class).
- not-validator (class).
- one-of (function).
- one-of-validator (class).
- or-validator (class).
- pathname-validator (class).
- regex-validator (class).
- string-validator (class).
- symbol-validator (class).
- true-validator (class).
- type-validator (class).
- url-validator (class).
- valid-datetime (function).
- valid-email (function).
- valid-pathname (function).
- valid-url (function).
- validate (function).
- validation-error (function).
- validation-error (condition).
- validation-error-message (generic reader).
- validation-error-target (generic reader).
- validator (generic reader).
- (setf validator) (generic writer).
- validator (class).
- validator-collection (class).
- validator-message (function).
- with-signal-validation-errors (macro).
- ~ (function).
- ~= (function).
- Internals
- %collecting-validation-errors (function).
- %validate (generic function).
- absolute-p (generic reader).
- (setf absolute-p) (generic writer).
- object (generic reader).
- (setf object) (generic writer).
- options (generic reader).
- (setf options) (generic writer).
- pathname-type* (generic reader).
- (setf pathname-type*) (generic writer).
- probe-p (generic reader).
- (setf probe-p) (generic writer).
- valid-email-address-p (function).
- valid-url-p (function).
- validator-function (generic reader).
- (setf validator-function) (generic writer).
- validator-max (generic reader).
- (setf validator-max) (generic writer).
- validator-max-message (generic reader).
- (setf validator-max-message) (generic writer).
- validator-min (generic reader).
- (setf validator-min) (generic writer).
- validator-min-message (generic reader).
- (setf validator-min-message) (generic writer).
- validator-number (generic reader).
- (setf validator-number) (generic writer).
- validator-regex (generic reader).
- (setf validator-regex) (generic writer).
- validator-type (generic reader).
- (setf validator-type) (generic writer).
- validators (generic reader).
- (setf validators) (generic writer).
- x (generic reader).
- (setf x) (generic writer).
- y (generic reader).
- (setf y) (generic writer).
Next: Indexes, Previous: Packages, Up: The clavier Reference Manual [Contents][Index]
5 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
5.1 Public Interface
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
5.1.1 Special variables
- Special Variable: *signal-validation-errors* ¶
-
- Package
- Source
Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]
5.1.2 Macros
- Macro: collecting-validation-errors ((errors found-p) expr &body body) ¶
-
- Package
- Source
- Macro: with-signal-validation-errors ((&optional signal) &body body) ¶
-
Enables/disables validation errors in body
Args: - signal(boolean) : If **T**, errors are signaled. If **NIL**, they are not.
- Package
- Source
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
5.1.3 Ordinary functions
- Function: ∅ (x y &optional message &rest args) ¶
-
- Package
- Source
- Function: && (x y &optional message &rest args) ¶
-
- Package
- Source
- Function: == (object &optional message &rest args) ¶
-
- Package
- Source
- Function: blank (&optional message &rest args) ¶
-
- Package
- Source
- Function: call-with-signal-validation-errors (func &optional signal) ¶
-
- Package
- Source
- Function: fn (function message &rest args) ¶
-
- Package
- Source
- Function: greater-than (number &optional message &rest args) ¶
-
- Package
- Source
- Function: is-a (type &optional message &rest args) ¶
-
- Package
- Source
- Function: is-a-boolean (&optional message &rest args) ¶
-
- Package
- Source
- Function: is-a-keyword (&optional message &rest args) ¶
-
- Package
- Source
- Function: is-a-list (&optional message &rest args) ¶
-
- Package
- Source
- Function: is-a-string (&optional message &rest args) ¶
-
- Package
- Source
- Function: is-a-symbol (&optional message &rest args) ¶
-
- Package
- Source
- Function: is-an-integer (&optional message &rest args) ¶
-
- Package
- Source
- Function: is-false (&optional message &rest args) ¶
-
- Package
- Source
- Function: is-true (&optional message &rest args) ¶
-
- Package
- Source
- Function: len (&key min max min-message max-message) ¶
-
- Package
- Source
- Function: less-than (number &optional message &rest args) ¶
-
- Package
- Source
- Function: matches-regex (regex &optional message &rest args) ¶
-
- Package
- Source
- Function: not-blank (&optional message &rest args) ¶
-
- Package
- Source
- Function: one-of (options &optional message &rest args) ¶
-
- Package
- Source
- Function: valid-datetime (&optional message &rest args) ¶
-
- Package
- Source
- Function: valid-email (&optional message &rest args) ¶
-
- Package
- Source
- Function: valid-pathname (&optional message &rest args) ¶
-
- Package
- Source
- Function: valid-url (&optional message &rest args) ¶
-
- Package
- Source
- Function: validate (validator object &rest args &key error-p message &allow-other-keys) ¶
-
- Package
- Source
- Function: validation-error (target error-msg &rest args) ¶
-
- Package
- Source
- Function: validator-message (validator object) ¶
-
Returns the validator message for the given object
- Package
- Source
- Function: ~ (validator &optional message &rest args) ¶
-
- Package
- Source
- Function: ~= (object &optional message &rest args) ¶
-
- Package
- Source
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
5.1.4 Generic functions
- Generic Reader: message (object) ¶
- Generic Writer: (setf message) (object) ¶
- Generic Reader: validation-error-message (condition) ¶
-
- Package
- Methods
- Reader Method: validation-error-message ((condition validation-error)) ¶
-
- Source
- Target Slot
- Generic Reader: validation-error-target (condition) ¶
-
- Package
- Methods
- Reader Method: validation-error-target ((condition validation-error)) ¶
-
- Source
- Target Slot
- Generic Reader: validator (object) ¶
-
- Package
- Methods
- Reader Method: validator ((not-validator not-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf validator) (object) ¶
-
- Package
- Methods
- Writer Method: (setf validator) ((not-validator not-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
5.1.5 Standalone methods
- Method: print-object ((validation-error validation-error) stream) ¶
-
- Source
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
5.1.6 Conditions
- Condition: validation-error ¶
-
- Package
- Source
- Direct superclasses
error.
- Direct methods
- Direct slots
- Slot: target ¶
-
- Initform
(quote (error "set up the target"))
- Initargs
:target
- Readers
- Writers
This slot is read-only.
- Slot: error-msg ¶
-
- Initform
(quote (error "provide the error message"))
- Initargs
:error-msg
- Readers
- Writers
This slot is read-only.
Previous: Conditions, Up: Public Interface [Contents][Index]
5.1.7 Classes
- Class: and-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (format nil ~a or ~a (let ((x-validator (x validator))) (validator-message x-validator object)) (let ((y-validator (y validator))) (validator-message y-validator object)))) - Direct slots
- Class: blank-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil should be blank))
- Class: boolean-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct Default Initargs
Initarg Value :type (quote boolean) :message (lambda (validator object) (format nil ~a is not a boolean object))
- Class: datetime-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil ~a is not a valid timestamp object))
- Class: email-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil the email is invalid: ~a object))
- Class: equal-to-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (format nil ~a is not equal to ~a object (object validator))) - Direct slots
- Slot: object ¶
-
- Initform
(error "provide the object")
- Initargs
:object
- Readers
- Writers
- Class: false-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil is not false))
- Class: function-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct slots
- Slot: function ¶
-
- Package
common-lisp.
- Initform
(error "provide the function")
- Initargs
:function
- Readers
- Writers
- Class: greater-than-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil ~a is not greater than ~a object (validator-number validator))) - Direct slots
- Slot: number ¶
-
- Package
common-lisp.
- Initform
(error "provide the number")
- Initargs
:number
- Readers
- Writers
- Class: integer-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct Default Initargs
Initarg Value :type (quote integer) :message (lambda (validator object) (format nil ~a is not an integer object))
- Class: keyword-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct Default Initargs
Initarg Value :type (quote keyword) :message (lambda (validator object) (format nil ~a is not a keyword object))
- Class: length-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message size is not correct - Direct slots
- Slot: min ¶
-
Minimum length
- Package
common-lisp.
- Initargs
:min
- Readers
- Writers
- Slot: max ¶
-
Maximum length
- Package
common-lisp.
- Initargs
:max
- Readers
- Writers
- Slot: min-message ¶
-
Message for when length is below minimum
- Initargs
:min-message
- Readers
- Writers
- Slot: max-message ¶
-
Message for when length is above maximum
- Initargs
:max-message
- Readers
- Writers
- Class: less-than-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil ~a is not lower than ~a object (validator-number validator))) - Direct slots
- Slot: number ¶
-
- Package
common-lisp.
- Initform
(error "provide the number")
- Initargs
:number
- Readers
- Writers
- Class: list-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct Default Initargs
Initarg Value :type (quote list) :message (lambda (validator object) (format nil ~a is not a list object))
- Class: not-blank-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil should not be blank))
- Class: not-equal-to-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (format nil ~a is equal to ~a object (object validator))) - Direct slots
- Slot: object ¶
-
- Initform
(error "provide the object")
- Initargs
:object
- Readers
- Writers
- Class: not-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (format nil not ~a (validator-message (validator validator) object))) - Direct slots
- Slot: validator ¶
-
- Initform
(error "provide the validator")
- Initargs
:validator
- Readers
- Writers
- Class: one-of-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil should be one of ~{~a~} (options validator))) - Direct slots
- Slot: options ¶
-
- Initform
(error "provide the options")
- Initargs
:options
- Readers
- Writers
- Class: or-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (format nil ~a and ~a (let ((x-validator (x validator))) (validator-message x-validator object)) (let ((y-validator (y validator))) (validator-message y-validator object)))) - Direct slots
- Class: pathname-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil ~a is not a valid pathname object)) - Direct slots
- Slot: absolute-p ¶
-
If the pathname should be absolute
- Initargs
:absolute-p
- Readers
- Writers
- Slot: probe-p ¶
-
Probe existance of pathname
- Initargs
:probe-p
- Readers
- Writers
- Slot: pathname-type ¶
-
The pathname type
- Package
common-lisp.
- Initargs
:pathname-type
- Readers
- Writers
- Class: regex-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil ~a does not match the regex ~s object (validator-regex validator))) - Direct slots
- Slot: regex ¶
-
- Initform
(error "provide the regex")
- Initargs
:regex
- Readers
- Writers
- Class: string-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct Default Initargs
Initarg Value :type (quote string) :message (lambda (validator object) (declare (ignore validator)) (format nil ~s is not a string object))
- Class: symbol-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct Default Initargs
Initarg Value :type (quote symbol) :message (lambda (validator object) (format nil ~a is not a symbol object))
- Class: true-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil is not true))
- Class: type-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct subclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (format nil ~a is not of type ~a object (validator-type validator))) - Direct slots
- Slot: type ¶
-
- Package
common-lisp.
- Initform
(error "provide the type")
- Initargs
:type
- Readers
- Writers
- Class: url-validator ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (validator object) (declare (ignorable validator object)) (format nil ~a is not a valid url object))
- Class: validator ¶
-
- Package
- Source
- Direct superclasses
funcallable-standard-object.
- Direct subclasses
- and-validator.
- blank-validator.
- datetime-validator.
- email-validator.
- equal-to-validator.
- false-validator.
- function-validator.
- greater-than-validator.
- length-validator.
- less-than-validator.
- not-blank-validator.
- not-equal-to-validator.
- not-validator.
- one-of-validator.
- or-validator.
- pathname-validator.
- regex-validator.
- true-validator.
- type-validator.
- url-validator.
- validator-collection.
- Direct methods
- Direct slots
- Slot: message ¶
-
- Initform
(error "provide the validation error message")
- Initargs
:message
- Readers
- Writers
- Class: validator-collection ¶
-
- Package
- Source
- Direct superclasses
- Direct methods
- Direct Default Initargs
Initarg Value :message (lambda (&rest args) ) - Direct slots
- Slot: validators ¶
-
- Initargs
:validators
- Readers
- Writers
Previous: Public Interface, Up: Definitions [Contents][Index]
5.2 Internals
Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]
5.2.1 Ordinary functions
- Function: %collecting-validation-errors (func) ¶
-
- Package
- Source
- Function: valid-email-address-p (string) ¶
-
- Package
- Source
- Function: valid-url-p (string) ¶
-
- Package
- Source
Previous: Ordinary functions, Up: Internals [Contents][Index]
5.2.2 Generic functions
- Generic Function: %validate (validator object &rest args) ¶
-
- Package
- Source
- Methods
- Method: %validate ((validator greater-than-validator) object &rest args) ¶
- Method: %validate ((validator less-than-validator) object &rest args) ¶
- Method: %validate ((validator one-of-validator) object &rest args) ¶
- Method: %validate ((validator or-validator) object &rest args) ¶
- Method: %validate ((validator and-validator) object &rest args) ¶
- Method: %validate ((validator not-validator) object &rest args) ¶
- Method: %validate ((validator pathname-validator) object &rest args) ¶
- Method: %validate ((validator datetime-validator) object &rest args) ¶
- Method: %validate ((validator regex-validator) object &rest args) ¶
- Method: %validate ((validator url-validator) object &rest args) ¶
- Method: %validate ((validator email-validator) object &rest args) ¶
- Method: %validate ((validator length-validator) object &rest args) ¶
- Method: %validate ((validator false-validator) object &rest args) ¶
- Method: %validate ((validator true-validator) object &rest args) ¶
- Method: %validate ((validator not-blank-validator) object &rest args) ¶
- Method: %validate ((validator blank-validator) object &rest args) ¶
- Method: %validate ((validator function-validator) object &rest args) ¶
- Method: %validate ((validator type-validator) object &rest args) ¶
- Method: %validate ((validator not-equal-to-validator) object &rest args) ¶
- Method: %validate ((validator equal-to-validator) object &rest args) ¶
- Method: %validate ((validator validator-collection) object &rest args) ¶
- Method: %validate (validator object &rest args) ¶
- Generic Reader: absolute-p (object) ¶
- Generic Writer: (setf absolute-p) (object) ¶
-
- Package
- Methods
- Reader Method: absolute-p ((pathname-validator pathname-validator)) ¶
- Writer Method: (setf absolute-p) ((pathname-validator pathname-validator)) ¶
-
If the pathname should be absolute
- Source
- Target Slot
- Generic Reader: object (object) ¶
-
- Package
- Methods
- Reader Method: object ((not-equal-to-validator not-equal-to-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Reader Method: object ((equal-to-validator equal-to-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf object) (object) ¶
-
- Package
- Methods
- Writer Method: (setf object) ((not-equal-to-validator not-equal-to-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Writer Method: (setf object) ((equal-to-validator equal-to-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: options (object) ¶
-
- Package
- Methods
- Reader Method: options ((one-of-validator one-of-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf options) (object) ¶
-
- Package
- Methods
- Writer Method: (setf options) ((one-of-validator one-of-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: pathname-type* (object) ¶
- Generic Writer: (setf pathname-type*) (object) ¶
-
- Package
- Methods
- Reader Method: pathname-type* ((pathname-validator pathname-validator)) ¶
- Writer Method: (setf pathname-type*) ((pathname-validator pathname-validator)) ¶
-
The pathname type
- Source
- Target Slot
- Generic Reader: probe-p (object) ¶
- Generic Writer: (setf probe-p) (object) ¶
-
- Package
- Methods
- Reader Method: probe-p ((pathname-validator pathname-validator)) ¶
- Writer Method: (setf probe-p) ((pathname-validator pathname-validator)) ¶
-
Probe existance of pathname
- Source
- Target Slot
- Generic Reader: validator-function (object) ¶
-
- Package
- Methods
- Reader Method: validator-function ((function-validator function-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf validator-function) (object) ¶
-
- Package
- Methods
- Writer Method: (setf validator-function) ((function-validator function-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: validator-max (object) ¶
- Generic Writer: (setf validator-max) (object) ¶
-
- Package
- Methods
- Reader Method: validator-max ((length-validator length-validator)) ¶
- Writer Method: (setf validator-max) ((length-validator length-validator)) ¶
-
Maximum length
- Source
- Target Slot
max.
- Generic Reader: validator-max-message (object) ¶
- Generic Writer: (setf validator-max-message) (object) ¶
-
- Package
- Methods
- Reader Method: validator-max-message ((length-validator length-validator)) ¶
- Writer Method: (setf validator-max-message) ((length-validator length-validator)) ¶
-
Message for when length is above maximum
- Source
- Target Slot
- Generic Reader: validator-min (object) ¶
- Generic Writer: (setf validator-min) (object) ¶
-
- Package
- Methods
- Reader Method: validator-min ((length-validator length-validator)) ¶
- Writer Method: (setf validator-min) ((length-validator length-validator)) ¶
-
Minimum length
- Source
- Target Slot
min.
- Generic Reader: validator-min-message (object) ¶
- Generic Writer: (setf validator-min-message) (object) ¶
-
- Package
- Methods
- Reader Method: validator-min-message ((length-validator length-validator)) ¶
- Writer Method: (setf validator-min-message) ((length-validator length-validator)) ¶
-
Message for when length is below minimum
- Source
- Target Slot
- Generic Reader: validator-number (object) ¶
-
- Package
- Methods
- Reader Method: validator-number ((greater-than-validator greater-than-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Reader Method: validator-number ((less-than-validator less-than-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf validator-number) (object) ¶
-
- Package
- Methods
- Writer Method: (setf validator-number) ((greater-than-validator greater-than-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Writer Method: (setf validator-number) ((less-than-validator less-than-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: validator-regex (object) ¶
-
- Package
- Methods
- Reader Method: validator-regex ((regex-validator regex-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf validator-regex) (object) ¶
-
- Package
- Methods
- Writer Method: (setf validator-regex) ((regex-validator regex-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: validator-type (object) ¶
-
- Package
- Methods
- Reader Method: validator-type ((type-validator type-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
type.
- Generic Writer: (setf validator-type) (object) ¶
-
- Package
- Methods
- Writer Method: (setf validator-type) ((type-validator type-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
type.
- Generic Reader: validators (object) ¶
-
- Package
- Methods
- Reader Method: validators ((validator-collection validator-collection)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf validators) (object) ¶
-
- Package
- Methods
- Writer Method: (setf validators) ((validator-collection validator-collection)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: x (object) ¶
-
- Package
- Methods
- Reader Method: x ((or-validator or-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
x.
- Reader Method: x ((and-validator and-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
x.
- Generic Writer: (setf x) (object) ¶
-
- Package
- Methods
- Writer Method: (setf x) ((or-validator or-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
x.
- Writer Method: (setf x) ((and-validator and-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
x.
- Generic Reader: y (object) ¶
-
- Package
- Methods
- Reader Method: y ((or-validator or-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
y.
- Reader Method: y ((and-validator and-validator)) ¶
-
automatically generated reader method
- Source
- Target Slot
y.
- Generic Writer: (setf y) (object) ¶
-
- Package
- Methods
- Writer Method: (setf y) ((or-validator or-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
y.
- Writer Method: (setf y) ((and-validator and-validator)) ¶
-
automatically generated writer method
- Source
- Target Slot
y.
Previous: Definitions, Up: The clavier Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| Jump to: | %
&
(
=
~
∅
A B C F G I L M N O P V W X Y |
|---|
| Jump to: | %
&
(
=
~
∅
A B C F G I L M N O P V W X Y |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| Jump to: | *
A E F M N O P R S T V X Y |
|---|
| Jump to: | *
A E F M N O P R S T V X Y |
|---|
A.4 Data types
| Jump to: | A B C D E F G I K L N O P R S T U V |
|---|
| Jump to: | A B C D E F G I K L N O P R S T U V |
|---|