The fmarshal Reference Manual

Table of Contents

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

The fmarshal Reference Manual

This is the fmarshal Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:13:51 2018 GMT+0.


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

1 Introduction

* Use Cases
** DONE Marshal List
#+BEGIN_SRC lisp
  (fmarshal:load (fmarshal:dump (list 1 (list 2 3) 4)))
  ;; => (1 (2 3) 4)

#+END_SRC

** DONE Marshal Vector
#+BEGIN_SRC lisp
  (fmarshal:load (fmarshal:dump #(1 #(2 3) 4)))
  ;; => #(1 #(2 3) 4)

  (fmarshal:load (fmarshal:dump (make-array (list 2 2) :initial-element 0)))
  ;; => # #2A((0 0) (0 0))

#+END_SRC

** DONE Marshal Hashmap
#+BEGIN_SRC lisp

  (let ((h (make-hash-table :test 'equal)))
    (setf (gethash "blub" h) t)
    (gethash "blub" (fmarshal:load (fmarshal:dump h))))
  ;; => T


#+END_SRC

** DONE Marshal Object
#+BEGIN_SRC lisp
  (defclass test-object ()
    (test-slot))

  (let ((o (make-instance 'test-object)))
    (setf (slot-value o 'test-slot) "blub")
    (slot-value (fmarshal:load (fmarshal:dump o)) 'test-slot))
  ;; => "blub"

#+END_SRC
** DONE Marshal References
#+BEGIN_SRC lisp
  (defclass test-inherited (test-object)
    (object-slot))

  (let ((o (make-instance 'test-inherited)))
    (setf (slot-value o 'test-slot) "blub")
    (setf (slot-value o 'object-slot) o)
    (let ((loaded-object (fmarshal:load (fmarshal:dump o))))
      (values
       (slot-value loaded-object 'test-slot)
       (eq loaded-object (slot-value loaded-object 'object-slot)))))
  ;; => "blub", T

#+END_SRC


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

2 Systems

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


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

2.1 fmarshal

Maintainer

Jürgen Bickert <juergenbickert@gmail.com>

Author

Jürgen Bickert <juergenbickert@gmail.com>

License

LGPL

Description

dump and load objects

Version

1.0.0

Dependency

closer-mop

Source

fmarshal.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 fmarshal.asd

Location

fmarshal.asd

Systems

fmarshal (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 fmarshal/fmarshal.lisp

Dependency

readme.org (file)

Parent

fmarshal (system)

Location

fmarshal.lisp

Packages

fmarshal

Exported Definitions
Internal Definitions

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

3.2 Other


Previous: , Up: Other files   [Contents][Index]

3.2.1 fmarshal/README.org

Parent

fmarshal (system)

Location

README.org


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

4 Packages

Packages are listed by definition order.


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

4.1 fmarshal

Source

fmarshal.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: dump OBJECT &optional STREAM
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load STREAM
Package

fmarshal

Source

fmarshal.lisp (file)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *next-ref*
Package

fmarshal

Source

fmarshal.lisp (file)

Special Variable: *refs*
Package

fmarshal

Source

fmarshal.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: maybe-dump-ref O &body BODY
Package

fmarshal

Source

fmarshal.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: dump-array A STREAM
Package

fmarshal

Source

fmarshal.lisp (file)

Function: dump-array-helper DIM A REF STREAM
Package

fmarshal

Source

fmarshal.lisp (file)

Function: dump-hash-table H STREAM
Package

fmarshal

Source

fmarshal.lisp (file)

Function: dump-ref REF STREAM
Package

fmarshal

Source

fmarshal.lisp (file)

Function: dump-slot-definitions OBJECT STREAM
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load-array A
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load-array-helper A REF DIM
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load-hash-table TEST DESC
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load-helper DESC
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load-list LIST
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load-object CLASS SLOTS-DESC
Package

fmarshal

Source

fmarshal.lisp (file)

Function: load-string S
Package

fmarshal

Source

fmarshal.lisp (file)

Function: next-ref ()
Package

fmarshal

Source

fmarshal.lisp (file)

Function: unmarshalize STREAM
Package

fmarshal

Source

fmarshal.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: dump-helper OBJECT STREAM
Package

fmarshal

Source

fmarshal.lisp (file)

Methods
Method: dump-helper OBJECT STREAM
Method: dump-helper (S symbol) STREAM
Method: dump-helper (H hash-table) STREAM
Method: dump-helper (A array) STREAM
Method: dump-helper (L cons) STREAM
Method: dump-helper (N number) STREAM
Method: dump-helper (C character) STREAM
Method: dump-helper (S string) STREAM

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   O  
Index Entry  Section

F
File, Lisp, fmarshal.asd: The fmarshal<dot>asd file
File, Lisp, fmarshal/fmarshal.lisp: The fmarshal/fmarshal<dot>lisp file
File, other, fmarshal/README.org: The fmarshal/readme<dot>org file
fmarshal.asd: The fmarshal<dot>asd file
fmarshal/fmarshal.lisp: The fmarshal/fmarshal<dot>lisp file
fmarshal/README.org: The fmarshal/readme<dot>org file

L
Lisp File, fmarshal.asd: The fmarshal<dot>asd file
Lisp File, fmarshal/fmarshal.lisp: The fmarshal/fmarshal<dot>lisp file

O
Other File, fmarshal/README.org: The fmarshal/readme<dot>org file

Jump to:   F   L   O  

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

A.2 Functions

Jump to:   D   F   G   L   M   N   U  
Index Entry  Section

D
dump: Exported functions
dump-array: Internal functions
dump-array-helper: Internal functions
dump-hash-table: Internal functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-helper: Internal generic functions
dump-ref: Internal functions
dump-slot-definitions: Internal functions

F
Function, dump: Exported functions
Function, dump-array: Internal functions
Function, dump-array-helper: Internal functions
Function, dump-hash-table: Internal functions
Function, dump-ref: Internal functions
Function, dump-slot-definitions: Internal functions
Function, load: Exported functions
Function, load-array: Internal functions
Function, load-array-helper: Internal functions
Function, load-hash-table: Internal functions
Function, load-helper: Internal functions
Function, load-list: Internal functions
Function, load-object: Internal functions
Function, load-string: Internal functions
Function, next-ref: Internal functions
Function, unmarshalize: Internal functions

G
Generic Function, dump-helper: Internal generic functions

L
load: Exported functions
load-array: Internal functions
load-array-helper: Internal functions
load-hash-table: Internal functions
load-helper: Internal functions
load-list: Internal functions
load-object: Internal functions
load-string: Internal functions

M
Macro, maybe-dump-ref: Internal macros
maybe-dump-ref: Internal macros
Method, dump-helper: Internal generic functions
Method, dump-helper: Internal generic functions
Method, dump-helper: Internal generic functions
Method, dump-helper: Internal generic functions
Method, dump-helper: Internal generic functions
Method, dump-helper: Internal generic functions
Method, dump-helper: Internal generic functions
Method, dump-helper: Internal generic functions

N
next-ref: Internal functions

U
unmarshalize: Internal functions

Jump to:   D   F   G   L   M   N   U  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*next-ref*: Internal special variables
*refs*: Internal special variables

S
Special Variable, *next-ref*: Internal special variables
Special Variable, *refs*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   F   P   S  
Index Entry  Section

F
fmarshal: The fmarshal system
fmarshal: The fmarshal package

P
Package, fmarshal: The fmarshal package

S
System, fmarshal: The fmarshal system

Jump to:   F   P   S