diff options
| author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-19 15:47:54 +0200 |
|---|---|---|
| committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-21 15:58:41 +0200 |
| commit | 041b70cd1cd7883a12a71612784d937361aa5efd (patch) | |
| tree | 098cc98f73c5f1e71fe6b6bacc6d08cc4b921f9a /doc/ref/guile/save-load.texi | |
| parent | Remove old unit-test style seraliazation tests. (diff) | |
| download | calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.gz calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.xz | |
Split data-store and data-format indo separate doc pages.
Diffstat (limited to 'doc/ref/guile/save-load.texi')
| -rw-r--r-- | doc/ref/guile/save-load.texi | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/doc/ref/guile/save-load.texi b/doc/ref/guile/save-load.texi deleted file mode 100644 index 136b2f39..00000000 --- a/doc/ref/guile/save-load.texi +++ /dev/null @@ -1,63 +0,0 @@ -@node Saving and Loading -@section Saving and Loading - -@subsection Data Formats -A data format is some way that an individual event may get serialized -to disk. The default is iCalendar (TODO reference RFC 5545), but -others might be available (TODO footnote and reference xcal). - -Each available format should be included as -@code{(vcomponent formats @var{format-name})}. -Which module corresponds to what file type is currently defined out of band. - -Each module should expose the following procedures. - -@defun serialize component port -Write a serialized representation of @var{component} to @var{port}. -@end defun - -@defun deserialize port -Read a serialized representation of a component from @var{port}, and -return the deserialized instance of this object. -@end defun - -@subsubsection iCalendar -RFC 5545 - -@subsubsection xCal - -@subsection Data Stores -Data stores are persistant stores for events, such as databases or the -file system. Each data store can support any number of data formats, -but which is an implementation detail of that format and shouldn't be -needed information from the high level view. -@footnote{It is however important for interoperability with other programs}. - -@c (make <calendar-store> #:path ``hello'') - -@defun path store -@end defun - -@deftp {GOOPS method} get-calendar this -Returns a vcomponent object of type @code{VCALENDAR}. Should contain -all @code{VEVENT} components of this calendar. -@end deftp - -@deftp {GOOPS method} get-by-uid this uid -Return the event object with UID equal to the string @var{uid}. -@end deftp - -@deftp {GOOPS method} queue-save this event -Queue a save event of @var{event} to the store. -@end deftp - -@deftp {GOOPS method} flush this -Force write of all queued actions. -@end deftp - -@subsubsection VDir -[VDIR]: http://vdirsyncer.pimutils.org/en/latest/vdir.html - -@subsubsection File - -@subsubsection SQLite |