/[cl-store]/cl-store/README
ViewVC logotype

Contents of /cl-store/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.10 - (show annotations)
Mon Nov 1 14:30:18 2004 UTC (9 years, 5 months ago) by sross
Branch: MAIN
Changes since 1.9: +3 -84 lines
Removed old documentation, added new docs.
1 README for Package CL-STORE.
2 Author: Sean Ross
3 Homepage: http://www.common-lisp.net/project/cl-store/
4 Version: 0.3.2
5
6 0. About.
7 CL-STORE is an portable serialization package which
8 should give you the ability to store all common-lisp
9 data types (well not all yet) into streams.
10 See the cl-store manual (docs/cl-store.texi) for more in depth information.
11
12 1. Usage
13 The main entry points are
14 - [Function] cl-store:store (obj place &optional (backend *default-backend*)) i
15 => obj
16 Where place is a path designator or stream and
17 backend is one of the registered backends.
18
19 - [Function] cl-store:restore (place &optional (backend *default-backend*))
20 => restored-objects
21 Where place and backend is as above.
22
23 - [Macro] cl-store:multiple-value-store (values-form place &optional (backend *default-backend*))
24 => objects
25 Stores all the values returned by VALUES-FORM into place as per cl-store:store.
26
27 - cl-store:restore is setfable, which I think makes
28 for a great serialized hit counter.
29 eg. (incf (restore place))
30
31 NOTE.
32 All errors signalled within store and restore can
33 be handled by catching store-error and restore-error respectively.
34
35 Enjoy
36 Sean.

  ViewVC Help
Powered by ViewVC 1.1.5