The auto-restart Reference Manual

This is the auto-restart Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 04:19:46 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 auto-restart

automatically generate restart-cases for the most common use cases, and also use the restart for automatic retries

Author

Arnold Noronha <>

License

Apache License, Version 2.0

Version

0.0.1

Dependency

iterate (system).

Source

auto-restart.asd.

Child Component

auto-restart.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 auto-restart/auto-restart.asd

Source

auto-restart.asd.

Parent Component

auto-restart (system).

ASDF Systems

auto-restart.


3.1.2 auto-restart/auto-restart.lisp

Source

auto-restart.asd.

Parent Component

auto-restart (system).

Packages

auto-restart.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 auto-restart

Source

auto-restart.lisp.

Use List
  • common-lisp.
  • iterate.
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: *global-enable-auto-retries-p*

Globally enable or disable automatic retries. Useful for unit tests.

Package

auto-restart.

Source

auto-restart.lisp.


5.1.2 Macros

Macro: with-auto-restart ((&key retries sleep restart-name) &body body)
Package

auto-restart.

Source

auto-restart.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *attempt*
Package

auto-restart.

Source

auto-restart.lisp.


5.2.2 Ordinary functions

Function: call-with-auto-restart (restart-name fn)
Package

auto-restart.

Source

auto-restart.lisp.

Function: fix-args-for-funcall (var-names)
Package

auto-restart.

Source

auto-restart.lisp.


5.2.3 Conditions

Condition: restart-already-defined

When calling with-auto-restart, we expect the restart to be defined inside the body, not before it.

Package

auto-restart.

Source

auto-restart.lisp.

Direct superclasses

error.

Direct slots
Slot: restart-name
Package

common-lisp.

Initargs

:restart-name


Appendix A Indexes


A.1 Concepts