The persistent-variables Reference Manual

This is the persistent-variables Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:50:16 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 persistent-variables

A library for persistent global variables.

Author

Warren Wilkinson <>

License

lgpl2

Version

1.0.0

Source

persistent-variables.asd.

Child Component

persistent-variables.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 persistent-variables/persistent-variables.asd

Source

persistent-variables.asd.

Parent Component

persistent-variables (system).

ASDF Systems

persistent-variables.


3.1.2 persistent-variables/persistent-variables.lisp

Source

persistent-variables.asd.

Parent Component

persistent-variables (system).

Packages

persistent-variables.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 persistent-variables

Source

persistent-variables.lisp.

Nickname

pv

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: *default-set*
Package

persistent-variables.

Source

persistent-variables.lisp.


5.1.2 Macros

Macro: defpvar (name &optional val doc set)

Define persistent variable, it’ll take it’s cached value if available.

Package

persistent-variables.

Source

persistent-variables.lisp.


5.1.3 Ordinary functions

Function: persist (name &optional set)

Add a variable to persistence serialization.

Package

persistent-variables.

Source

persistent-variables.lisp.

Function: pv-load (stream &optional set)

Load variable bindings from stream and set persistent-variables..

Package

persistent-variables.

Source

persistent-variables.lisp.

Function: pv-save (stream &optional set)

Save all defpvar values to stream.

Package

persistent-variables.

Source

persistent-variables.lisp.

Function: unpersist (name &optional set)

Remove a variable from persistence serialization.

Package

persistent-variables.

Source

persistent-variables.lisp.


5.1.4 Generic functions

Generic Reader: expression (condition)
Package

persistent-variables.

Methods
Reader Method: expression ((condition unloadable-variable))
Source

persistent-variables.lisp.

Target Slot

expression.

Generic Reader: name (condition)
Package

persistent-variables.

Methods
Reader Method: name ((condition unloadable-variable))
Source

persistent-variables.lisp.

Target Slot

name.

Generic Reader: text (condition)
Package

persistent-variables.

Methods
Reader Method: text ((condition unloadable-variable))
Source

persistent-variables.lisp.

Target Slot

text.


5.1.5 Standalone methods

Method: print-object ((c unloadable-variable) stream)
Source

persistent-variables.lisp.


5.1.6 Conditions

Condition: unloadable-variable
Package

persistent-variables.

Source

persistent-variables.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: text
Initargs

:text

Readers

text.

Writers

This slot is read-only.

Slot: expression
Initargs

:expression

Readers

expression.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *loaded*

Store loaded values that are missing their corresponding variables.

Package

persistent-variables.

Source

persistent-variables.lisp.

Special Variable: *persisted*
Package

persistent-variables.

Source

persistent-variables.lisp.


5.2.2 Ordinary functions

Function: cached-string (package name &optional set)
Package

persistent-variables.

Source

persistent-variables.lisp.

Function: cached-string-forget (symbol &optional set)
Package

persistent-variables.

Source

persistent-variables.lisp.

Function: pv-read (symbol value)

Attempt to read a saved value.

Package

persistent-variables.

Source

persistent-variables.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions