The trivial-hashtable-serialize Reference Manual

This is the trivial-hashtable-serialize Reference Manual, version 0.1.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:10:26 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-hashtable-serialize

A simple method to serialize and deserialize hash-tables.

Author

Eric Diethelm <>

License

MIT

Version

0.1.4

Dependency

split-sequence (system).

Source

trivial-hashtable-serialize.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 trivial-hashtable-serialize/trivial-hashtable-serialize.asd

Source

trivial-hashtable-serialize.asd.

Parent Component

trivial-hashtable-serialize (system).

ASDF Systems

trivial-hashtable-serialize.


3.1.3 trivial-hashtable-serialize/trivial-hashtable-serialize.lisp

Source

trivial-hashtable-serialize.asd.

Parent Component

trivial-hashtable-serialize (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-hashtable-serialize

trivial-hashtable-serialize provides a simple and probably naïve way to serialize hash-tables.

Source

package.lisp.

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 Ordinary functions

Function: load-hashtable (file-name &key if-does-not-exist deserialize-fn)

Read the contents of *FILE-NAME* and deserialize it into a new hash-table. *IF-DOES-NOT-EXIST* accepts the same values as the equaly named key in *WITH-OPEN-FILE*. *DESERIALIZE-FN* can be defined to use a non-default serialization function.

The signature of *DESERIALIZE-FN* is (function (line) (values key value)).

Package

trivial-hashtable-serialize.

Source

trivial-hashtable-serialize.lisp.

Function: save-hashtable (table file-name &key serialize-fn)

Serializes the hash-table *TABLE* into the file identified by *FILE-NAME*. A non-default serialization function can be given through *SERIALIZE-FN*.
The signature of *SERIALIZE-FN* is (function (stream key value) null).

Package

trivial-hashtable-serialize.

Source

trivial-hashtable-serialize.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: default-deserialize-fn (line)

This function deserializes key/value pairs serialized by *DEFAULT-SERIALIZE-FN*.

Package

trivial-hashtable-serialize.

Source

trivial-hashtable-serialize.lisp.

Function: default-serialize-fn (stream key value)

This is the default serialization function. It uses #$ to separate key and values.

See also *DEFAULT-DESERIALIZE-FN*.

Package

trivial-hashtable-serialize.

Source

trivial-hashtable-serialize.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables