The persistent-variables Reference Manual

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

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 Mon Aug 15 05:33:47 2022 GMT+0.

Table of Contents


1 Introduction

persistent-variables

1 Overview

Persistent variables can be serialized to and from streams.

They come with niceties, like restarts for failed serialization, late binding (loaded values are cached until the variable is defined), and a test suite.

1.1 Features

2 Installation

2.1 Quick Lisp

Install Quick Lisp and then run:

If you have problems, see the support section, and you may want to run the tests.

2.2 Gentoo

As root,

Once the emerge is finished, the package can be loaded using ASDF:

If you have problems, see the support section, otherwise you may want to run the tests.

2.3 Ubunto

Once the installation is finished, the package is loadable using ASDF:

If you have problems, see the support section, otherwise you may want to run the tests.

2.4 Manual Installation

In summary: Untar the .tar package and then symlink the .asd files into a place where ASDF can find them.

  1. Untar the files where you want them to be. On windows download the .zip and unzip it instead, it's the same files.

  2. ASDF could be looking anywhere -- it depends on your setup. Run this in your lisp repl to get a clue as to where ASDF is seeking libraries:

  3. Symlink the .asd files to the source directory. If you use windows, these instructions on symlink alternatives apply to you.

Once the files are in place, the package can be loaded with ASDF by:

If you have problems, see the support section. If you don't have problems you may want to run the tests anyway, because you can.

2.5 Running the Tests

Once the system is loaded, it can be tested with asdf.

This should display something like the following. There should be zero failures, if you have failures see the support section of this document.

2.6 Getting Support

You can find support on this libraries website and/or github repository. Or you can email Warren Wilkinson.

3 License

Persister is distributed under the LGPL2 License.


2 Systems

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


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

2.1 persistent-variables

A library for persistent global variables.

Author

Warren Wilkinson <warrenwilkinson@gmail.com>

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.


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

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.


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

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.


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

5.1 Public Interface


Next: , Previous: , Up: Public Interface   [Contents][Index]

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


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

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.


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

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


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

A.1 Concepts


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

A.2 Functions

Jump to:   C   D   E   F   G   M   N   P   T   U  
Index Entry  Section

C
cached-string: Private ordinary functions
cached-string-forget: Private ordinary functions

D
defpvar: Public macros

E
expression: Public generic functions
expression: Public generic functions

F
Function, cached-string: Private ordinary functions
Function, cached-string-forget: Private ordinary functions
Function, persist: Public ordinary functions
Function, pv-load: Public ordinary functions
Function, pv-read: Private ordinary functions
Function, pv-save: Public ordinary functions
Function, unpersist: Public ordinary functions

G
Generic Function, expression: Public generic functions
Generic Function, name: Public generic functions
Generic Function, text: Public generic functions

M
Macro, defpvar: Public macros
Method, expression: Public generic functions
Method, name: Public generic functions
Method, print-object: Public standalone methods
Method, text: Public generic functions

N
name: Public generic functions
name: Public generic functions

P
persist: Public ordinary functions
print-object: Public standalone methods
pv-load: Public ordinary functions
pv-read: Private ordinary functions
pv-save: Public ordinary functions

T
text: Public generic functions
text: Public generic functions

U
unpersist: Public ordinary functions

Jump to:   C   D   E   F   G   M   N   P   T   U