The data-sift Reference Manual

This is the data-sift Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:13:08 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 data-sift

Dependencies
  • cl-ppcre (system).
  • parse-number (system).
  • alexandria (system).
  • puri (system).
Source

data-sift.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 data-sift/src

Source

data-sift.asd.

Parent Component

data-sift (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 data-sift/data-sift.asd

Source

data-sift.asd.

Parent Component

data-sift (system).

ASDF Systems

data-sift.


4.1.2 data-sift/src/packages.lisp

Source

data-sift.asd.

Parent Component

src (module).

Packages

data-sift.


4.1.3 data-sift/src/conditions.lisp

Dependency

packages.lisp (file).

Source

data-sift.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 data-sift/src/sift.lisp

Dependency

conditions.lisp (file).

Source

data-sift.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 data-sift

Source

packages.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Generic functions

Generic Function: compile-parse-rule (rule &key message regex case-insensitive-mode multi-line-mode single-line-mode extended-mode min-value max-value strip min-length max-length &allow-other-keys)

Compile a validator according to RULE

Package

data-sift.

Source

sift.lisp.

Methods
Method: compile-parse-rule ((rule (eql data-sift::required)) &key message)
Method: compile-parse-rule ((rule (eql data-sift:email)) &key message)
Method: compile-parse-rule ((rule (eql data-sift:regexp)) &key regex message case-insensitive-mode multi-line-mode single-line-mode extended-mode)
Method: compile-parse-rule ((rule (eql number)) &key min-value max-value message)
Method: compile-parse-rule ((rule (eql integer)) &key min-value max-value message)
Method: compile-parse-rule ((rule (eql string)) &key strip min-length max-length message)
Method: compile-parse-rule ((rule function) &key &allow-other-keys)
Method: compile-parse-rule ((symbol symbol) &rest args &key &allow-other-keys)
Method: compile-parse-rule ((rule cons) &key)
Generic Function: compile-render-rule (rule &key &allow-other-keys)

Compile a renderer according to RULE

Package

data-sift.

Source

sift.lisp.

Methods
Method: compile-render-rule (rule &key &allow-other-keys)
Generic Reader: validation-fail-message (condition)
Package

data-sift.

Methods
Reader Method: validation-fail-message ((condition validation-fail))
Source

conditions.lisp.

Target Slot

message.

Reader Method: validation-fail-message ((condition invalid-rule))
Source

conditions.lisp.

Target Slot

message.


6.1.2 Conditions

Condition: invalid-rule
Package

data-sift.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: source
Initform

(quote nil)

Initargs

:source

Readers

invalid-rule-source.

Writers

This slot is read-only.

Slot: message
Initform

(quote nil)

Initargs

:message

Readers

validation-fail-message.

Writers

This slot is read-only.

Condition: stop-validation
Package

data-sift.

Source

conditions.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: value
Initform

(quote nil)

Readers

stop-validation-value.

Writers

This slot is read-only.

Slot: message
Initform

(quote nil)

Readers

stop-validation-message.

Writers

This slot is read-only.

Condition: validation-fail
Package

data-sift.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

validation-fail-message.

Direct slots
Slot: message
Initform

(quote nil)

Initargs

:message

Readers

validation-fail-message.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: *re-email-check*
Package

data-sift.

Source

sift.lisp.


6.2.2 Ordinary functions

Function: default-renderer (obj)
Package

data-sift.

Source

sift.lisp.

Function: strip (str)
Package

data-sift.

Source

sift.lisp.

Function: vfail (messsage &rest args)
Package

data-sift.

Source

conditions.lisp.


6.2.3 Generic functions

Generic Function: compile-format-rule (rule &key &allow-other-keys)
Package

data-sift.

Methods
Method: compile-format-rule ((symbol symbol) &rest args &key &allow-other-keys)
Source

sift.lisp.

Method: compile-format-rule ((rule cons) &key)
Source

sift.lisp.

Generic Reader: invalid-rule-source (condition)
Package

data-sift.

Methods
Reader Method: invalid-rule-source ((condition invalid-rule))
Source

conditions.lisp.

Target Slot

source.

Generic Reader: stop-validation-message (condition)
Package

data-sift.

Methods
Reader Method: stop-validation-message ((condition stop-validation))
Source

conditions.lisp.

Target Slot

message.

Generic Reader: stop-validation-value (condition)
Package

data-sift.

Methods
Reader Method: stop-validation-value ((condition stop-validation))
Source

conditions.lisp.

Target Slot

value.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   G   I   M   S   V  
Index Entry  Section

C
compile-format-rule: Private generic functions
compile-format-rule: Private generic functions
compile-format-rule: Private generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-parse-rule: Public generic functions
compile-render-rule: Public generic functions
compile-render-rule: Public generic functions

D
default-renderer: Private ordinary functions

F
Function, default-renderer: Private ordinary functions
Function, strip: Private ordinary functions
Function, vfail: Private ordinary functions

G
Generic Function, compile-format-rule: Private generic functions
Generic Function, compile-parse-rule: Public generic functions
Generic Function, compile-render-rule: Public generic functions
Generic Function, invalid-rule-source: Private generic functions
Generic Function, stop-validation-message: Private generic functions
Generic Function, stop-validation-value: Private generic functions
Generic Function, validation-fail-message: Public generic functions

I
invalid-rule-source: Private generic functions
invalid-rule-source: Private generic functions

M
Method, compile-format-rule: Private generic functions
Method, compile-format-rule: Private generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-parse-rule: Public generic functions
Method, compile-render-rule: Public generic functions
Method, invalid-rule-source: Private generic functions
Method, stop-validation-message: Private generic functions
Method, stop-validation-value: Private generic functions
Method, validation-fail-message: Public generic functions
Method, validation-fail-message: Public generic functions

S
stop-validation-message: Private generic functions
stop-validation-message: Private generic functions
stop-validation-value: Private generic functions
stop-validation-value: Private generic functions
strip: Private ordinary functions

V
validation-fail-message: Public generic functions
validation-fail-message: Public generic functions
validation-fail-message: Public generic functions
vfail: Private ordinary functions