The statusor Reference Manual

This is the statusor Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:58:30 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 statusor

A library for graceful handling of errors in common lisp inspired by absl::StatusOr<T>

Author

Ernesto Alfonso <>

License

BSD

Source

statusor.asd.

Child Component

statusor.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 statusor/statusor.asd

Source

statusor.asd.

Parent Component

statusor (system).

ASDF Systems

statusor.


3.1.2 statusor/statusor.lisp

Source

statusor.asd.

Parent Component

statusor (system).

Packages

statusor.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 statusor

Source

statusor.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: ->? (forms &optional on-error-spec)
Package

statusor.

Source

statusor.lisp.

Macro: error-to-signal (form)
Package

statusor.

Source

statusor.lisp.

Macro: handle-error (form &optional on-success-spec on-error-spec)
Package

statusor.

Source

statusor.lisp.

Macro: if-let-ok (on-error-spec bindings &rest on-success)
Package

statusor.

Source

statusor.lisp.

Macro: make-error (error-message)
Package

statusor.

Source

statusor.lisp.

Macro: nil-to-error (form &optional error-message)
Package

statusor.

Source

statusor.lisp.

Macro: return-if-error (form &optional block-name)
Package

statusor.

Source

statusor.lisp.

Macro: signal-to-error (form &optional error-message-prefix)
Package

statusor.

Source

statusor.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables