The destructuring-bind-star Reference Manual

Table of Contents

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

The destructuring-bind-star Reference Manual

This is the destructuring-bind-star Reference Manual, version 0.0.1, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Fri May 24 08:45:06 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

DESTRUCTURING-BIND*

The standard DESTRUCTURING-BIND signals an error of type ERROR when the destructuring fails. That's not too specific of a condition if you want to catch specifically destructuring errors, eh?

The macro DESTRUCTURING-BIND* available from this system instead signals a custom error of type DESTRUCTURING-ERROR which contains readers for the expression that was attempted to be destructured, the lambda-expression that was destructured against, and the original error that was signaled during destructuring.

Exports

Usage

Either use the DESTRUCTURING-BIND-STAR package and call the DESTRUCTURING-BIND* macro, or shadow the DESTRUCTURING-BIND symbol and:

(setf (macro-function 'destructuring-bind)
      (macro-function 'destructuring-bind-star:destructuring-bind*))

MIT License

Copyright © 2018 Michał "phoe" Herda.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 destructuring-bind-star

Author

Michał "phoe" Herda <phoe@disroot.org>

License

MIT

Description

DESTRUCTURING-BIND with proper error signaling

Version

0.0.1

Source

destructuring-bind-star.asd (file)

Component

destructuring-bind-star.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 destructuring-bind-star.asd

Location

destructuring-bind-star.asd

Systems

destructuring-bind-star (system)


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

destructuring-bind-star (system)

Location

destructuring-bind-star.lisp

Packages

destructuring-bind-star

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 destructuring-bind-star

Source

destructuring-bind-star.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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-BIND-ERROR.

Package

destructuring-bind-star

Source

destructuring-bind-star.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Generic functions

Generic Function: expression CONDITION
Package

destructuring-bind-star

Methods
Method: expression (CONDITION destructuring-error)
Source

destructuring-bind-star.lisp (file)

Generic Function: lambda-list CONDITION
Package

destructuring-bind-star

Methods
Method: lambda-list (CONDITION destructuring-error)
Source

destructuring-bind-star.lisp (file)

Generic Function: reason CONDITION
Package

destructuring-bind-star

Methods
Method: reason (CONDITION destructuring-error)
Source

destructuring-bind-star.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: %expression
Initargs

:expression

Initform

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

Readers

expression (generic function)

Slot: %lambda-list
Initargs

:lambda-list

Initform

(quote (quote nil))

Readers

lambda-list (generic function)

Slot: %reason
Initargs

:reason

Initform

(quote nil)

Readers

reason (generic function)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: bind-modify-lambda-list LAMBDA-LIST GENSYM
Package

destructuring-bind-star

Source

destructuring-bind-star.lisp (file)

Function: extract-declarations BODY
Package

destructuring-bind-star

Source

destructuring-bind-star.lisp (file)

Function: print-destructuring-error CONDITION STREAM
Package

destructuring-bind-star

Source

destructuring-bind-star.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   D   F   L  
Index Entry  Section

D
destructuring-bind-star.asd: The destructuring-bind-star<dot>asd file
destructuring-bind-star/destructuring-bind-star.lisp: The destructuring-bind-star/destructuring-bind-star<dot>lisp file

F
File, Lisp, destructuring-bind-star.asd: The destructuring-bind-star<dot>asd file
File, Lisp, destructuring-bind-star/destructuring-bind-star.lisp: The destructuring-bind-star/destructuring-bind-star<dot>lisp file

L
Lisp File, destructuring-bind-star.asd: The destructuring-bind-star<dot>asd file
Lisp File, destructuring-bind-star/destructuring-bind-star.lisp: The destructuring-bind-star/destructuring-bind-star<dot>lisp file

Jump to:   D   F   L  

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

A.2 Functions

Jump to:   B   D   E   F   G   L   M   P   R  
Index Entry  Section

B
bind-modify-lambda-list: Internal functions

D
destructuring-bind*: Exported macros

E
expression: Exported generic functions
expression: Exported generic functions
extract-declarations: Internal functions

F
Function, bind-modify-lambda-list: Internal functions
Function, extract-declarations: Internal functions
Function, print-destructuring-error: Internal functions

G
Generic Function, expression: Exported generic functions
Generic Function, lambda-list: Exported generic functions
Generic Function, reason: Exported generic functions

L
lambda-list: Exported generic functions
lambda-list: Exported generic functions

M
Macro, destructuring-bind*: Exported macros
Method, expression: Exported generic functions
Method, lambda-list: Exported generic functions
Method, reason: Exported generic functions

P
print-destructuring-error: Internal functions

R
reason: Exported generic functions
reason: Exported generic functions

Jump to:   B   D   E   F   G   L   M   P   R  

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

A.3 Variables

Jump to:   %  
S  
Index Entry  Section

%
%expression: Exported conditions
%lambda-list: Exported conditions
%reason: Exported conditions

S
Slot, %expression: Exported conditions
Slot, %lambda-list: Exported conditions
Slot, %reason: Exported conditions

Jump to:   %  
S  

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

A.4 Data types

Jump to:   C   D   P   S  
Index Entry  Section

C
Condition, destructuring-error: Exported conditions

D
destructuring-bind-star: The destructuring-bind-star system
destructuring-bind-star: The destructuring-bind-star package
destructuring-error: Exported conditions

P
Package, destructuring-bind-star: The destructuring-bind-star package

S
System, destructuring-bind-star: The destructuring-bind-star system

Jump to:   C   D   P   S