The safety-params Reference Manual

This is the safety-params Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 07:24:31 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 safety-params

Filter parameters

Author

Eitaro Fukamachi

License

BSD 2-Clause

Version

0.3.0

Dependencies
  • parse-number (system).
  • alexandria (system).
Source

safety-params.asd.

Child Component

src (module).


3 Modules

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


3.1 safety-params/src

Source

safety-params.asd.

Parent Component

safety-params (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 safety-params/safety-params.asd

Source

safety-params.asd.

Parent Component

safety-params (system).

ASDF Systems

safety-params.


4.1.2 safety-params/src/main.lisp

Dependencies
Source

safety-params.asd.

Parent Component

src (module).

Packages

safety-params.

Public Interface

4.1.3 safety-params/src/conversions.lisp

Dependency

errors.lisp (file).

Source

safety-params.asd.

Parent Component

src (module).

Packages

safety-params/conversions.

Public Interface
Internals

4.1.4 safety-params/src/assertions.lisp

Dependency

errors.lisp (file).

Source

safety-params.asd.

Parent Component

src (module).

Packages

safety-params/assertions.

Public Interface
Internals

4.1.5 safety-params/src/messages.lisp

Dependency

assertions.lisp (file).

Source

safety-params.asd.

Parent Component

src (module).

Packages

safety-params/messages.


4.1.6 safety-params/src/errors.lisp

Dependency

utils.lisp (file).

Source

safety-params.asd.

Parent Component

src (module).

Packages

safety-params/errors.

Public Interface
Internals

4.1.7 safety-params/src/utils.lisp

Source

safety-params.asd.

Parent Component

src (module).

Packages

safety-params/utils.

Public Interface

5 Packages

Packages are listed by definition order.


5.1 safety-params/assertions

Source

assertions.lisp.

Use List
Used By List

safety-params.

Public Interface
Internals

5.2 safety-params/errors

Source

errors.lisp.

Use List
Used By List
Public Interface
Internals

5.3 safety-params/conversions

Source

conversions.lisp.

Use List
  • common-lisp.
  • org.mapcar.parse-number.
Used By List

safety-params.

Public Interface
Internals

5.4 safety-params/utils

Source

utils.lisp.

Use List

common-lisp.

Used By List

safety-params/errors.

Public Interface

5.5 safety-params/messages

Source

messages.lisp.

Use List

common-lisp.


5.6 safety-params

Source

main.lisp.

Use List
Public Interface

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: alist (&rest preds)
Package

safety-params/assertions.

Source

assertions.lisp.

Macro: being (type &optional default)
Package

safety-params/conversions.

Source

conversions.lisp.

Macro: sanitize (form params)
Package

safety-params.

Source

main.lisp.

Macro: validate (form params)
Package

safety-params.

Source

main.lisp.

Macro: with-continuable (&body body)
Package

safety-params/errors.

Source

errors.lisp.


6.1.2 Ordinary functions

Function: being* (type default)
Package

safety-params/conversions.

Source

conversions.lisp.

Function: function-name (function)
Package

safety-params/utils.

Source

utils.lisp.

Function: lambda-function-p (function)
Package

safety-params/utils.

Source

utils.lisp.

Function: list-of (pred)
Package

safety-params/assertions.

Source

assertions.lisp.

Function: validation-message (pred)
Package

safety-params/errors.

Source

errors.lisp.

Function: (setf validation-message) (pred)
Package

safety-params/errors.

Source

errors.lisp.


6.1.3 Generic functions

Generic Function: converts-into (from to-type)
Package

safety-params/conversions.

Source

conversions.lisp.

Methods
Method: converts-into ((from string) to-type)
Method: converts-into ((from string) (to-type (eql number)))
Method: converts-into (from to-type)
Generic Reader: invalid-keys (condition)
Generic Writer: (setf invalid-keys) (condition)
Package

safety-params/errors.

Methods
Reader Method: invalid-keys ((condition validation-error))
Writer Method: (setf invalid-keys) ((condition validation-error))
Source

errors.lisp.

Target Slot

invalid.

Generic Reader: missing-keys (condition)
Generic Writer: (setf missing-keys) (condition)
Package

safety-params/errors.

Methods
Reader Method: missing-keys ((condition validation-error))
Writer Method: (setf missing-keys) ((condition validation-error))
Source

errors.lisp.

Target Slot

missing.

Generic Reader: unpermitted-keys (condition)
Generic Writer: (setf unpermitted-keys) (condition)
Package

safety-params/errors.

Methods
Reader Method: unpermitted-keys ((condition validation-error))
Writer Method: (setf unpermitted-keys) ((condition validation-error))
Source

errors.lisp.

Target Slot

unpermitted.


6.1.4 Standalone methods

Method: print-object ((conversion conversion) stream)
Source

conversions.lisp.


6.1.5 Conditions

Condition: assertion-failed
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

safety-params-error.

Direct subclasses

invalid-input.

Direct slots
Slot: value
Initargs

:value

Slot: test
Initargs

:test

Condition: conversion-failed
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

safety-params-error.

Direct slots
Slot: value
Initargs

:value

Slot: expected
Initargs

:expected

Condition: invalid-input
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

assertion-failed.

Direct slots
Slot: value
Initargs

:value

Condition: missing-required-keys
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

safety-params-error.

Direct methods
Direct slots
Slot: keys
Initargs

:keys

Readers

missing-required-keys-keys.

Writers

(setf missing-required-keys-keys).

Condition: not-satisfied-key
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

safety-params-error.

Direct methods
Direct slots
Slot: key
Initargs

:key

Readers

not-satisfied-key-key.

Writers

This slot is read-only.

Slot: pred
Initargs

:pred

Readers

not-satisfied-key-pred.

Writers

This slot is read-only.

Slot: message
Initform

(quote nil)

Initargs

:message

Condition: safety-params-error
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

error.

Direct subclasses
Condition: unpermitted-keys
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

safety-params-error.

Direct methods
Direct slots
Slot: keys
Initargs

:keys

Readers

unpermitted-keys-keys.

Writers

(setf unpermitted-keys-keys).

Condition: validation-error
Package

safety-params/errors.

Source

errors.lisp.

Direct superclasses

safety-params-error.

Direct methods
Direct slots
Slot: missing
Initform

(quote (quote nil))

Initargs

:missing

Readers

missing-keys.

Writers

(setf missing-keys).

Slot: invalid
Initform

(quote (quote nil))

Initargs

:invalid

Readers

invalid-keys.

Writers

(setf invalid-keys).

Slot: unpermitted
Initform

(quote (quote nil))

Initargs

:unpermitted

Readers

unpermitted-keys.

Writers

(setf unpermitted-keys).


6.2 Internals


6.2.1 Special variables

Special Variable: *params*
Package

safety-params/assertions.

Source

assertions.lisp.

Special Variable: *validation-message*
Package

safety-params/errors.

Source

errors.lisp.


6.2.2 Ordinary functions

Function: %permits (&rest keys)
Package

safety-params/assertions.

Source

assertions.lisp.

Function: %requires (&rest keys)
Package

safety-params/assertions.

Source

assertions.lisp.

Function: %satisfies (key pred &key message)
Package

safety-params/assertions.

Source

assertions.lisp.

Reader: conversion-default (instance)
Writer: (setf conversion-default) (instance)
Package

safety-params/conversions.

Source

conversions.lisp.

Target Slot

default.

Reader: conversion-fn (instance)
Writer: (setf conversion-fn) (instance)
Package

safety-params/conversions.

Source

conversions.lisp.

Target Slot

fn.

Reader: conversion-name (instance)
Writer: (setf conversion-name) (instance)
Package

safety-params/conversions.

Source

conversions.lisp.

Target Slot

name.

Function: conversion-p (object)
Package

safety-params/conversions.

Source

conversions.lisp.

Function: copy-conversion (instance)
Package

safety-params/conversions.

Source

conversions.lisp.

Function: invoke-continue (e)
Package

safety-params/assertions.

Source

assertions.lisp.

Function: make-conversion (name fn &optional default)
Package

safety-params/conversions.

Source

conversions.lisp.

Function: not-satisfied-key-message (error)
Package

safety-params/errors.

Source

errors.lisp.


6.2.3 Generic functions

Generic Reader: missing-required-keys-keys (condition)
Generic Writer: (setf missing-required-keys-keys) (condition)
Package

safety-params/errors.

Methods
Reader Method: missing-required-keys-keys ((condition missing-required-keys))
Writer Method: (setf missing-required-keys-keys) ((condition missing-required-keys))
Source

errors.lisp.

Target Slot

keys.

Generic Reader: not-satisfied-key-key (condition)
Package

safety-params/errors.

Methods
Reader Method: not-satisfied-key-key ((condition not-satisfied-key))
Source

errors.lisp.

Target Slot

key.

Generic Reader: not-satisfied-key-pred (condition)
Package

safety-params/errors.

Methods
Reader Method: not-satisfied-key-pred ((condition not-satisfied-key))
Source

errors.lisp.

Target Slot

pred.

Generic Reader: unpermitted-keys-keys (condition)
Generic Writer: (setf unpermitted-keys-keys) (condition)
Package

safety-params/errors.

Methods
Reader Method: unpermitted-keys-keys ((condition unpermitted-keys))
Writer Method: (setf unpermitted-keys-keys) ((condition unpermitted-keys))
Source

errors.lisp.

Target Slot

keys.


6.2.4 Structures

Structure: conversion
Package

safety-params/conversions.

Source

conversions.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: name
Readers

conversion-name.

Writers

(setf conversion-name).

Slot: fn
Readers

conversion-fn.

Writers

(setf conversion-fn).

Slot: default
Readers

conversion-default.

Writers

(setf conversion-default).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   F   G   I   L   M   N   P   S   U   V   W  
Index Entry  Section

%
%permits: Private ordinary functions
%requires: Private ordinary functions
%satisfies: Private ordinary functions

(
(setf conversion-default): Private ordinary functions
(setf conversion-fn): Private ordinary functions
(setf conversion-name): Private ordinary functions
(setf invalid-keys): Public generic functions
(setf invalid-keys): Public generic functions
(setf missing-keys): Public generic functions
(setf missing-keys): Public generic functions
(setf missing-required-keys-keys): Private generic functions
(setf missing-required-keys-keys): Private generic functions
(setf unpermitted-keys): Public generic functions
(setf unpermitted-keys): Public generic functions
(setf unpermitted-keys-keys): Private generic functions
(setf unpermitted-keys-keys): Private generic functions
(setf validation-message): Public ordinary functions

A
alist: Public macros

B
being: Public macros
being*: Public ordinary functions

C
conversion-default: Private ordinary functions
conversion-fn: Private ordinary functions
conversion-name: Private ordinary functions
conversion-p: Private ordinary functions
converts-into: Public generic functions
converts-into: Public generic functions
converts-into: Public generic functions
converts-into: Public generic functions
copy-conversion: Private ordinary functions

F
Function, %permits: Private ordinary functions
Function, %requires: Private ordinary functions
Function, %satisfies: Private ordinary functions
Function, (setf conversion-default): Private ordinary functions
Function, (setf conversion-fn): Private ordinary functions
Function, (setf conversion-name): Private ordinary functions
Function, (setf validation-message): Public ordinary functions
Function, being*: Public ordinary functions
Function, conversion-default: Private ordinary functions
Function, conversion-fn: Private ordinary functions
Function, conversion-name: Private ordinary functions
Function, conversion-p: Private ordinary functions
Function, copy-conversion: Private ordinary functions
Function, function-name: Public ordinary functions
Function, invoke-continue: Private ordinary functions
Function, lambda-function-p: Public ordinary functions
Function, list-of: Public ordinary functions
Function, make-conversion: Private ordinary functions
Function, not-satisfied-key-message: Private ordinary functions
Function, validation-message: Public ordinary functions
function-name: Public ordinary functions

G
Generic Function, (setf invalid-keys): Public generic functions
Generic Function, (setf missing-keys): Public generic functions
Generic Function, (setf missing-required-keys-keys): Private generic functions
Generic Function, (setf unpermitted-keys): Public generic functions
Generic Function, (setf unpermitted-keys-keys): Private generic functions
Generic Function, converts-into: Public generic functions
Generic Function, invalid-keys: Public generic functions
Generic Function, missing-keys: Public generic functions
Generic Function, missing-required-keys-keys: Private generic functions
Generic Function, not-satisfied-key-key: Private generic functions
Generic Function, not-satisfied-key-pred: Private generic functions
Generic Function, unpermitted-keys: Public generic functions
Generic Function, unpermitted-keys-keys: Private generic functions

I
invalid-keys: Public generic functions
invalid-keys: Public generic functions
invoke-continue: Private ordinary functions

L
lambda-function-p: Public ordinary functions
list-of: Public ordinary functions

M
Macro, alist: Public macros
Macro, being: Public macros
Macro, sanitize: Public macros
Macro, validate: Public macros
Macro, with-continuable: Public macros
make-conversion: Private ordinary functions
Method, (setf invalid-keys): Public generic functions
Method, (setf missing-keys): Public generic functions
Method, (setf missing-required-keys-keys): Private generic functions
Method, (setf unpermitted-keys): Public generic functions
Method, (setf unpermitted-keys-keys): Private generic functions
Method, converts-into: Public generic functions
Method, converts-into: Public generic functions
Method, converts-into: Public generic functions
Method, invalid-keys: Public generic functions
Method, missing-keys: Public generic functions
Method, missing-required-keys-keys: Private generic functions
Method, not-satisfied-key-key: Private generic functions
Method, not-satisfied-key-pred: Private generic functions
Method, print-object: Public standalone methods
Method, unpermitted-keys: Public generic functions
Method, unpermitted-keys-keys: Private generic functions
missing-keys: Public generic functions
missing-keys: Public generic functions
missing-required-keys-keys: Private generic functions
missing-required-keys-keys: Private generic functions

N
not-satisfied-key-key: Private generic functions
not-satisfied-key-key: Private generic functions
not-satisfied-key-message: Private ordinary functions
not-satisfied-key-pred: Private generic functions
not-satisfied-key-pred: Private generic functions

P
print-object: Public standalone methods

S
sanitize: Public macros

U
unpermitted-keys: Public generic functions
unpermitted-keys: Public generic functions
unpermitted-keys-keys: Private generic functions
unpermitted-keys-keys: Private generic functions

V
validate: Public macros
validation-message: Public ordinary functions

W
with-continuable: Public macros


A.4 Data types

Jump to:   A   C   E   F   I   M   N   P   S   U   V  
Index Entry  Section

A
assertion-failed: Public conditions
assertions.lisp: The safety-params/src/assertions․lisp file

C
Condition, assertion-failed: Public conditions
Condition, conversion-failed: Public conditions
Condition, invalid-input: Public conditions
Condition, missing-required-keys: Public conditions
Condition, not-satisfied-key: Public conditions
Condition, safety-params-error: Public conditions
Condition, unpermitted-keys: Public conditions
Condition, validation-error: Public conditions
conversion: Private structures
conversion-failed: Public conditions
conversions.lisp: The safety-params/src/conversions․lisp file

E
errors.lisp: The safety-params/src/errors․lisp file

F
File, assertions.lisp: The safety-params/src/assertions․lisp file
File, conversions.lisp: The safety-params/src/conversions․lisp file
File, errors.lisp: The safety-params/src/errors․lisp file
File, main.lisp: The safety-params/src/main․lisp file
File, messages.lisp: The safety-params/src/messages․lisp file
File, safety-params.asd: The safety-params/safety-params․asd file
File, utils.lisp: The safety-params/src/utils․lisp file

I
invalid-input: Public conditions

M
main.lisp: The safety-params/src/main․lisp file
messages.lisp: The safety-params/src/messages․lisp file
missing-required-keys: Public conditions
Module, src: The safety-params/src module

N
not-satisfied-key: Public conditions

P
Package, safety-params: The safety-params package
Package, safety-params/assertions: The safety-params/assertions package
Package, safety-params/conversions: The safety-params/conversions package
Package, safety-params/errors: The safety-params/errors package
Package, safety-params/messages: The safety-params/messages package
Package, safety-params/utils: The safety-params/utils package

S
safety-params: The safety-params system
safety-params: The safety-params package
safety-params-error: Public conditions
safety-params.asd: The safety-params/safety-params․asd file
safety-params/assertions: The safety-params/assertions package
safety-params/conversions: The safety-params/conversions package
safety-params/errors: The safety-params/errors package
safety-params/messages: The safety-params/messages package
safety-params/utils: The safety-params/utils package
src: The safety-params/src module
Structure, conversion: Private structures
System, safety-params: The safety-params system

U
unpermitted-keys: Public conditions
utils.lisp: The safety-params/src/utils․lisp file

V
validation-error: Public conditions