The destructuring-bind-star Reference Manual

This is the destructuring-bind-star Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 17:56:34 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 destructuring-bind-star

DESTRUCTURING-BIND with proper error signaling

Author

Michał "phoe" Herda <>

License

MIT

Version

0.0.1

Source

destructuring-bind-star.asd.

Child Component

destructuring-bind-star.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 destructuring-bind-star/destructuring-bind-star.asd

Source

destructuring-bind-star.asd.

Parent Component

destructuring-bind-star (system).

ASDF Systems

destructuring-bind-star.


3.1.2 destructuring-bind-star/destructuring-bind-star.lisp

Source

destructuring-bind-star.asd.

Parent Component

destructuring-bind-star (system).

Packages

destructuring-bind-star.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 destructuring-bind-star

Source

destructuring-bind-star.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: destructuring-bind* (lambda-list expression &body body)

Like DESTRUCTURING-BIND, except destructuring errors are signaled as instances of condition type DESTRUCTURING-ERROR.

Package

destructuring-bind-star.

Source

destructuring-bind-star.lisp.


5.1.2 Generic functions

Generic Reader: expression (condition)
Package

destructuring-bind-star.

Methods
Reader Method: expression ((condition destructuring-error))
Source

destructuring-bind-star.lisp.

Target Slot

%expression.

Generic Reader: lambda-list (condition)
Package

destructuring-bind-star.

Methods
Reader Method: lambda-list ((condition destructuring-error))
Source

destructuring-bind-star.lisp.

Target Slot

%lambda-list.

Generic Reader: reason (condition)
Package

destructuring-bind-star.

Methods
Reader Method: reason ((condition destructuring-error))
Source

destructuring-bind-star.lisp.

Target Slot

%reason.


5.1.3 Conditions

Condition: destructuring-error

Condition type responsible for destructuring errors signaled in DESTRUCTURING-BIND*.

Package

destructuring-bind-star.

Source

destructuring-bind-star.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: %expression
Initform

(quote (error "must provide expression."))

Initargs

:expression

Readers

expression.

Writers

This slot is read-only.

Slot: %lambda-list
Initform

(quote (quote nil))

Initargs

:lambda-list

Readers

lambda-list.

Writers

This slot is read-only.

Slot: %reason
Initform

(quote nil)

Initargs

:reason

Readers

reason.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: bind-modify-lambda-list (lambda-list gensym)
Package

destructuring-bind-star.

Source

destructuring-bind-star.lisp.

Function: extract-declarations (body)
Package

destructuring-bind-star.

Source

destructuring-bind-star.lisp.

Function: print-destructuring-error (condition stream)
Package

destructuring-bind-star.

Source

destructuring-bind-star.lisp.


Appendix A Indexes


A.1 Concepts