Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the persistent-variables Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:23:15 2018 GMT+0.
| • Introduction: | What persistent-variables is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
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.
(defpvar *my-account-password*) ;; Don't give it a value in the source file! ;; At the Repl: (setf *my-account-password* "the-password") (with-open-file (s "/path/to/somewhere/else") (p-save s)) ;; Later, at startup: (with-open-file (s "/path/to/somewhere/else") (p-load s))
Install Quick Lisp and then run:
(ql:quickload 'persistent-variables)
If you have problems, see the support section, and you may want to run the tests.
As root,
emerge persistent-variables
Once the emerge is finished, the package can be loaded using ASDF:
(asdf:operate 'asdf:load-op :persistent-variables)
If you have problems, see the support section, otherwise you may want to run the tests.
sudo apt-get install persistent-variables
Once the installation is finished, the package is loadable using ASDF:
(asdf:operate 'asdf:load-op :persistent-variables)
If you have problems, see the support section, otherwise you may want to run the tests.
In summary: Untar the .tar package and then symlink the .asd files into a place where ASDF can find them.
Untar the files where you want them to be. On windows download the .zip and unzip it instead, it's the same files.
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:
(mapcan #'funcall asdf:*default-source-registries*)
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:
(asdf:operate 'asdf:load-op :persistent-variables)
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.
Once the system is loaded, it can be tested with asdf.
(asdf:operate 'asdf:test-op :persistent-variables)
This should display something like the following. There should be zero failures, if you have failures see the support section of this document.
RUNNING PERSISTENT-VARIABLE TESTS...
PERSISTENT-VARIABLE TEST RESULTS:
Tests: 8
Success: 8
Failures: 0
You can find support on this libraries website and/or github repository. Or you can email Warren Wilkinson.
Persister is distributed under the LGPL2 License.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The persistent-variables system: |
Warren Wilkinson <warrenwilkinson@gmail.com>
lgpl2
A library for persistent global variables.
1.0.0
persistent-variables.asd (file)
persistent-variables.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The persistent-variables.asd file: | ||
| • The persistent-variables/persistent-variables.lisp file: |
Next: The persistent-variables/persistent-variables<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
persistent-variables.asd
persistent-variables (system)
Previous: The persistent-variables<dot>asd file, Up: Lisp files [Contents][Index]
persistent-variables (system)
persistent-variables.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The persistent-variables package: |
persistent-variables.lisp (file)
pv
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables: | ||
| • Exported macros: | ||
| • Exported functions: | ||
| • Exported generic functions: | ||
| • Exported conditions: |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
persistent-variables.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Define persistent variable, it’ll take it’s cached value if available.
persistent-variables.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Add a variable to persistence serialization.
persistent-variables.lisp (file)
Load variable bindings from stream and set persistent-variables..
persistent-variables.lisp (file)
Save all defpvar values to stream.
persistent-variables.lisp (file)
Remove a variable from persistence serialization.
persistent-variables.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
persistent-variables.lisp (file)
persistent-variables.lisp (file)
persistent-variables.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
persistent-variables.lisp (file)
error (condition)
:name
name (generic function)
:text
text (generic function)
:expression
expression (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal functions: |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Store loaded values that are missing their corresponding variables.
persistent-variables.lisp (file)
persistent-variables.lisp (file)
Previous: Internal special variables, Up: Internal definitions [Contents][Index]
persistent-variables.lisp (file)
persistent-variables.lisp (file)
Attempt to read a saved value.
persistent-variables.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L P |
|---|
| Jump to: | F L P |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | C D E F G M N P T U |
|---|
| Jump to: | C D E F G M N P T U |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
E N S T |
|---|
| Jump to: | *
E N S T |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C P S U |
|---|
| Jump to: | C P S U |
|---|