Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-hash-table-destructuring Reference Manual

This is the cl-hash-table-destructuring Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:19:14 2024 GMT+0.

Next: Systems, Previous: The cl-hash-table-destructuring Reference Manual, Up: The cl-hash-table-destructuring Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-hash-table-destructuring Reference Manual [Contents][Index]

2 Systems

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

cl-hash-table-destructuring

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-hash-table-destructuring`

Hash table destructuring utils

Author: Andrey V. Tikhonov <andrey.tikhonov.mailbox@gmail.com>
License: WTFPL
Version: 0.0.1
Source: cl-hash-table-destructuring.asd.
Child Component: src (module).

Next: Files, Previous: Systems, Up: The cl-hash-table-destructuring Reference Manual [Contents][Index]

3 Modules

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

cl-hash-table-destructuring/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-hash-table-destructuring/src`

Source: cl-hash-table-destructuring.asd.
Parent Component: cl-hash-table-destructuring (system).
Child Component: cl-hash-table-destructuring.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-hash-table-destructuring Reference Manual [Contents][Index]

4 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

4.1 Lisp

cl-hash-table-destructuring/cl-hash-table-destructuring.asd
cl-hash-table-destructuring/src/cl-hash-table-destructuring.lisp

Next: cl-hash-table-destructuring/src/cl-hash-table-destructuring.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-hash-table-destructuring/cl-hash-table-destructuring.asd`

Source: cl-hash-table-destructuring.asd.
Parent Component: cl-hash-table-destructuring (system).
ASDF Systems: cl-hash-table-destructuring.
Packages: cl-hash-table-destructuring-asd.

Previous: cl-hash-table-destructuring/cl-hash-table-destructuring.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-hash-table-destructuring/src/cl-hash-table-destructuring.lisp`

Source

cl-hash-table-destructuring.asd.

Parent Component

src (module).

Packages

cl-hash-table-destructuring.

Public Interface

*keyfn* (special variable).
with-hash-table-items (macro).
with-hash-table-items-fn (macro).
with-hash-table-values (macro).
with-hash-table-values-fn (macro).

Internals

defhelper (macro).
function-designator (type).
item-entry (type).
make-expansions (function).
make-key-forms (function).
make-names (function).
non-keyword-symbol (type).

Next: Definitions, Previous: Files, Up: The cl-hash-table-destructuring Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-hash-table-destructuring
cl-hash-table-destructuring-asd

Next: cl-hash-table-destructuring-asd, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-hash-table-destructuring`

Source

cl-hash-table-destructuring.lisp.

Use List

common-lisp.

Public Interface

*keyfn* (special variable).
with-hash-table-items (macro).
with-hash-table-items-fn (macro).
with-hash-table-values (macro).
with-hash-table-values-fn (macro).

Internals

defhelper (macro).
function-designator (type).
item-entry (type).
make-expansions (function).
make-key-forms (function).
make-names (function).
non-keyword-symbol (type).

Previous: cl-hash-table-destructuring, Up: Packages [Contents][Index]

5.2 `cl-hash-table-destructuring-asd`

Source

cl-hash-table-destructuring.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The cl-hash-table-destructuring Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Special variables

Special Variable: *keyfn* ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Previous: Special variables, Up: Public Interface [Contents][Index]

6.1.2 Macros

Macro: with-hash-table-items ((&rest entries) hash-table-form &body body) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Macro: with-hash-table-items-fn ((&rest entries) (hash-table-form keyfn) &body body) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Macro: with-hash-table-values ((&rest entries) hash-table-form &body body) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Macro: with-hash-table-values-fn ((&rest entries) (hash-table-form keyfn) &body body) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Macros
Ordinary functions
Types

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Macros

Macro: defhelper (function-name lambda-list &body forms) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Next: Types, Previous: Macros, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: make-expansions (forms hash-table-name) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Function: make-key-forms (entries keyfn-name) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Function: make-names (entries) ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.3 Types

Type: function-designator () ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Type: item-entry () ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Type: non-keyword-symbol () ¶

Package: cl-hash-table-destructuring.
Source: cl-hash-table-destructuring.lisp.

Previous: Definitions, Up: The cl-hash-table-destructuring Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	D F M W

	Index Entry	Section

D
	`defhelper`:	Private macros

F
	`Function, make-expansions`:	Private ordinary functions
	`Function, make-key-forms`:	Private ordinary functions
	`Function, make-names`:	Private ordinary functions

M
	`Macro, defhelper`:	Private macros
	`Macro, with-hash-table-items`:	Public macros
	`Macro, with-hash-table-items-fn`:	Public macros
	`Macro, with-hash-table-values`:	Public macros
	`Macro, with-hash-table-values-fn`:	Public macros
	`make-expansions`:	Private ordinary functions
	`make-key-forms`:	Private ordinary functions
	`make-names`:	Private ordinary functions

W
	`with-hash-table-items`:	Public macros
	`with-hash-table-items-fn`:	Public macros
	`with-hash-table-values`:	Public macros
	`with-hash-table-values-fn`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`keyfn`:	Public special variables

S
	`Special Variable, keyfn`:	Public special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F I M N P S T

	Index Entry	Section

C
	`cl-hash-table-destructuring`:	The cl-hash-table-destructuring system
	`cl-hash-table-destructuring`:	The cl-hash-table-destructuring package
	`cl-hash-table-destructuring-asd`:	The cl-hash-table-destructuring-asd package
	`cl-hash-table-destructuring.asd`:	The cl-hash-table-destructuring/cl-hash-table-destructuring․asd file
	`cl-hash-table-destructuring.lisp`:	The cl-hash-table-destructuring/src/cl-hash-table-destructuring․lisp file

F
	`File, cl-hash-table-destructuring.asd`:	The cl-hash-table-destructuring/cl-hash-table-destructuring․asd file
	`File, cl-hash-table-destructuring.lisp`:	The cl-hash-table-destructuring/src/cl-hash-table-destructuring․lisp file
	`function-designator`:	Private types

I
	`item-entry`:	Private types

M
	`Module, src`:	The cl-hash-table-destructuring/src module

N
	`non-keyword-symbol`:	Private types

P
	`Package, cl-hash-table-destructuring`:	The cl-hash-table-destructuring package
	`Package, cl-hash-table-destructuring-asd`:	The cl-hash-table-destructuring-asd package

S
	`src`:	The cl-hash-table-destructuring/src module
	`System, cl-hash-table-destructuring`:	The cl-hash-table-destructuring system

T
	`Type, function-designator`:	Private types
	`Type, item-entry`:	Private types
	`Type, non-keyword-symbol`:	Private types

The cl-hash-table-destructuring Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-hash-table-destructuring

3 Modules

3.1 cl-hash-table-destructuring/src

4 Files

4.1 Lisp

4.1.1 cl-hash-table-destructuring/cl-hash-table-destructuring.asd

4.1.2 cl-hash-table-destructuring/src/cl-hash-table-destructuring.lisp

5 Packages

5.1 cl-hash-table-destructuring

5.2 cl-hash-table-destructuring-asd

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.2 Internals

6.2.1 Macros

6.2.2 Ordinary functions

6.2.3 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-hash-table-destructuring`

3.1 `cl-hash-table-destructuring/src`

4.1.1 `cl-hash-table-destructuring/cl-hash-table-destructuring.asd`

4.1.2 `cl-hash-table-destructuring/src/cl-hash-table-destructuring.lisp`

5.1 `cl-hash-table-destructuring`

5.2 `cl-hash-table-destructuring-asd`