The dynamic-collect Reference Manual

This is the dynamic-collect Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 06:02:42 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 dynamic-collect

A library for dynamic, continuable, and abortable collection.

Author

Robert Smith <>

License

BSD 3-clause (see LICENSE)

Source

dynamic-collect.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 dynamic-collect/dynamic-collect.asd

Source

dynamic-collect.asd.

Parent Component

dynamic-collect (system).

ASDF Systems

dynamic-collect.


3.1.2 dynamic-collect/package.lisp

Source

dynamic-collect.asd.

Parent Component

dynamic-collect (system).

Packages

dynamic-collect.


3.1.3 dynamic-collect/dynamic-collect.lisp

Dependency

package.lisp (file).

Source

dynamic-collect.asd.

Parent Component

dynamic-collect (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 dynamic-collect

Source

package.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 Special variables

Special Variable: *ensure-handled-collect*

If T, ensure that COLLECT forms are inside WITH-DYNAMIC-COLLECTION. If NIL, return the specified RETURN value from COLLECT.

Package

dynamic-collect.

Source

dynamic-collect.lisp.


5.1.2 Macros

Macro: with-dynamic-collection ((&key tag) &body body)

Dynamically collect messages that were signalled during the execution of BODY from COLLECT. Return a list of messages in the order they were collected. If TAG is provided, then only COLLECT forms which have the same tag will be accrued.

Package

dynamic-collect.

Source

dynamic-collect.lisp.


5.1.3 Ordinary functions

Function: collect (data &key return continuep tag)

Collect the data DATA in a WITH-DYNAMIC-COLLECTION
environment. Return the value RETURN from the form in the event the function is returned from.

If CONTINUEP is null, then collecting will cease and the
matching WITH-DYNAMIC-COLLECTION form will return.

The TAG denotes at which WITH-DYNAMIC-COLLECTION form the DATA will be accumulated.

Package

dynamic-collect.

Source

dynamic-collect.lisp.


5.2 Internals


5.2.1 Generic functions

Generic Reader: messenger-continuep (condition)
Package

dynamic-collect.

Methods
Reader Method: messenger-continuep ((condition messenger))
Source

dynamic-collect.lisp.

Target Slot

continuep.

Generic Reader: messenger-id (condition)
Package

dynamic-collect.

Methods
Reader Method: messenger-id ((condition messenger))
Source

dynamic-collect.lisp.

Target Slot

id.

Generic Reader: messenger-payload (condition)
Package

dynamic-collect.

Methods
Reader Method: messenger-payload ((condition messenger))
Source

dynamic-collect.lisp.

Target Slot

payload.

Generic Reader: messenger-tag (condition)
Package

dynamic-collect.

Methods
Reader Method: messenger-tag ((condition messenger))
Source

dynamic-collect.lisp.

Target Slot

tag.


5.2.2 Conditions

Condition: messenger

A condition to carry messages between parts of programs.

Package

dynamic-collect.

Source

dynamic-collect.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: payload
Initargs

:payload

Readers

messenger-payload.

Writers

This slot is read-only.

Slot: continuep
Initform

(quote t)

Initargs

:continuep

Readers

messenger-continuep.

Writers

This slot is read-only.

Slot: id
Initargs

:id

Readers

messenger-id.

Writers

This slot is read-only.

Slot: tag
Initform

(quote nil)

Initargs

:tag

Readers

messenger-tag.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts