The pk-serialize Reference Manual

This is the pk-serialize Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:52:47 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 pk-serialize

Serialization of Common Lisp data structures

Maintainer

plkrueger

Author

plkrueger <>

License

MIT

Dependency

closer-mop (system).

Source

pk-serialize.asd.

Child Component

serialize.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 pk-serialize/pk-serialize.asd

Source

pk-serialize.asd.

Parent Component

pk-serialize (system).

ASDF Systems

pk-serialize.


3.1.2 pk-serialize/serialize.lisp

Source

pk-serialize.asd.

Parent Component

pk-serialize (system).

Packages

pk-serialize.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 pk-serialize

Source

serialize.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 Generic functions

Generic Function: dump-to-file (file-path dump-list)
Package

pk-serialize.

Methods
Method: dump-to-file (file-path (dump-list list))
Source

serialize.lisp.

Generic Function: restore-from-file (path)
Package

pk-serialize.

Methods
Method: restore-from-file ((path pathname))
Source

serialize.lisp.

Generic Function: slots-to-dump (obj)
Package

pk-serialize.

Methods
Method: slots-to-dump ((obj standard-object))
Source

serialize.lisp.

Generic Function: slots-to-not-dump (obj)
Package

pk-serialize.

Methods
Method: slots-to-not-dump ((obj standard-object))
Source

serialize.lisp.


5.1.2 Standalone methods

Method: initialize-instance :after ((self ser-test-class) &key &allow-other-keys)
Source

serialize.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *debug-serialize*
Package

pk-serialize.

Source

serialize.lisp.

Special Variable: ++global-ser-test-var++
Package

pk-serialize.

Source

serialize.lisp.


5.2.2 Ordinary functions

Function: array-equal (arr1 arr2)
Package

pk-serialize.

Source

serialize.lisp.

Function: copy-test-struct (instance)
Package

pk-serialize.

Source

serialize.lisp.

Function: dotted-pair-p (c)
Package

pk-serialize.

Source

serialize.lisp.

Function: get-ref (obj &optional push-to-objs)
Package

pk-serialize.

Source

serialize.lisp.

Function: hash-equal (ht1 ht2)
Package

pk-serialize.

Source

serialize.lisp.

Function: increment-paren-num (pth)
Package

pk-serialize.

Source

serialize.lisp.

Function: init-for-dump ()
Package

pk-serialize.

Source

serialize.lisp.

Function: init-for-restore ()
Package

pk-serialize.

Source

serialize.lisp.

Function: make-test-struct (&key ts1 ts2)
Package

pk-serialize.

Source

serialize.lisp.

Function: pretty-init-args (init-form &key width)
Package

pk-serialize.

Source

serialize.lisp.

Function: pure-list-p (lst)
Package

pk-serialize.

Source

serialize.lisp.

Function: rename-data (path)
Package

pk-serialize.

Source

serialize.lisp.

Function: ser-test ()
Package

pk-serialize.

Source

serialize.lisp.

Function: set-slot-vals (inst slot-list slot-vals)
Package

pk-serialize.

Source

serialize.lisp.

Function: test-struct-p (object)
Package

pk-serialize.

Source

serialize.lisp.

Reader: test-struct-ts1 (instance)
Writer: (setf test-struct-ts1) (instance)
Package

pk-serialize.

Source

serialize.lisp.

Target Slot

ts1.

Reader: test-struct-ts2 (instance)
Writer: (setf test-struct-ts2) (instance)
Package

pk-serialize.

Source

serialize.lisp.

Target Slot

ts2.

Function: val-for-init (obj)
Package

pk-serialize.

Source

serialize.lisp.


5.2.3 Generic functions

Generic Function: all-superclasses (cl)
Package

pk-serialize.

Methods
Method: all-superclasses ((cl class))
Source

serialize.lisp.

Generic Function: alloc-form-for (obj)
Package

pk-serialize.

Methods
Method: alloc-form-for ((obj function))
Source

serialize.lisp.

Method: alloc-form-for ((obj standard-method))
Source

serialize.lisp.

Method: alloc-form-for ((obj standard-generic-function))
Source

serialize.lisp.

Method: alloc-form-for ((obj array))
Source

serialize.lisp.

Method: alloc-form-for ((obj hash-table))
Source

serialize.lisp.

Method: alloc-form-for ((obj pathname))
Source

serialize.lisp.

Method: alloc-form-for ((obj structure-object))
Source

serialize.lisp.

Method: alloc-form-for ((obj standard-object))
Source

serialize.lisp.

Method: alloc-form-for ((obj symbol))
Source

serialize.lisp.

Method: alloc-form-for ((obj class))
Source

serialize.lisp.

Method: alloc-form-for ((obj stream))
Source

serialize.lisp.

Generic Function: array-contents (ar)
Package

pk-serialize.

Methods
Method: array-contents ((ar array))
Source

serialize.lisp.

Generic Reader: array-slot (object)
Package

pk-serialize.

Methods
Reader Method: array-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

array-slot.

Generic Writer: (setf array-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf array-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

array-slot.

Generic Reader: class-alloc-slot (object)
Package

pk-serialize.

Methods
Reader Method: class-alloc-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

class-alloc-slot.

Generic Writer: (setf class-alloc-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf class-alloc-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

class-alloc-slot.

Generic Function: class-class-slots (cl)
Package

pk-serialize.

Methods
Method: class-class-slots ((cl class))
Source

serialize.lisp.

Generic Function: class-instance-slots (cl)
Package

pk-serialize.

Methods
Method: class-instance-slots ((cl class))
Source

serialize.lisp.

Generic Function: constructor-name (obj)
Package

pk-serialize.

Methods
Method: constructor-name ((obj structure-object))
Source

serialize.lisp.

Generic Function: constructor-name-with-package (obj)
Package

pk-serialize.

Methods
Method: constructor-name-with-package ((obj function))
Source

serialize.lisp.

Generic Reader: func-slot (object)
Package

pk-serialize.

Methods
Reader Method: func-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

func-slot.

Generic Writer: (setf func-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf func-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

func-slot.

Generic Reader: hash-slot (object)
Package

pk-serialize.

Methods
Reader Method: hash-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

hash-slot.

Generic Writer: (setf hash-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf hash-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

hash-slot.

Generic Function: init (obj &rest args)
Package

pk-serialize.

Methods
Method: init ((obj null) &rest args)
Source

serialize.lisp.

Method: init ((ar array) &rest args)
Source

serialize.lisp.

Method: init ((ht hash-table) &rest args)
Source

serialize.lisp.

Method: init ((obj symbol) &rest args)
Source

serialize.lisp.

Method: init ((obj standard-object) &rest args)
Source

serialize.lisp.

Method: init ((obj class) &rest args)
Source

serialize.lisp.

Method: init ((obj structure-object) &rest args)
Source

serialize.lisp.

Generic Function: init-form-for (obj)
Package

pk-serialize.

Methods
Method: init-form-for ((obj array))
Source

serialize.lisp.

Method: init-form-for ((obj hash-table))
Source

serialize.lisp.

Method: init-form-for ((obj standard-method))
Source

serialize.lisp.

Method: init-form-for ((obj standard-generic-function))
Source

serialize.lisp.

Method: init-form-for ((obj function))
Source

serialize.lisp.

Method: init-form-for ((obj pathname))
Source

serialize.lisp.

Method: init-form-for ((obj symbol))
Source

serialize.lisp.

Method: init-form-for ((obj standard-object))
Source

serialize.lisp.

Method: init-form-for ((obj class))
Source

serialize.lisp.

Method: init-form-for ((obj structure-object))
Source

serialize.lisp.

Method: init-form-for (obj)
Source

serialize.lisp.

Generic Reader: list-slot (object)
Package

pk-serialize.

Methods
Reader Method: list-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

list-slot.

Generic Writer: (setf list-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf list-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

list-slot.

Generic Function: name-with-package (sym)
Package

pk-serialize.

Methods
Method: name-with-package ((obj structure-object))
Source

serialize.lisp.

Method: name-with-package ((obj standard-object))
Source

serialize.lisp.

Method: name-with-package ((class class))
Source

serialize.lisp.

Method: name-with-package ((sym symbol))
Source

serialize.lisp.

Generic Reader: null-slot (object)
Package

pk-serialize.

Methods
Reader Method: null-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

null-slot.

Generic Writer: (setf null-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf null-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

null-slot.

Generic Reader: path-slot (object)
Package

pk-serialize.

Methods
Reader Method: path-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

path-slot.

Generic Writer: (setf path-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf path-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

path-slot.

Generic Function: replace-refs-in (obj)
Package

pk-serialize.

Methods
Method: replace-refs-in ((obj symbol))
Source

serialize.lisp.

Method: replace-refs-in ((obj cons))
Source

serialize.lisp.

Method: replace-refs-in (obj)
Source

serialize.lisp.

Generic Reader: string-slot (object)
Package

pk-serialize.

Methods
Reader Method: string-slot ((ser-test-class ser-test-class))

automatically generated reader method

Source

serialize.lisp.

Target Slot

string-slot.

Generic Writer: (setf string-slot) (object)
Package

pk-serialize.

Methods
Writer Method: (setf string-slot) ((ser-test-class ser-test-class))

automatically generated writer method

Source

serialize.lisp.

Target Slot

string-slot.


5.2.4 Structures

Structure: test-struct
Package

pk-serialize.

Source

serialize.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: ts1
Initform

1

Readers

test-struct-ts1.

Writers

(setf test-struct-ts1).

Slot: ts2
Initform

2

Readers

test-struct-ts2.

Writers

(setf test-struct-ts2).


5.2.5 Classes

Class: ser-test-class
Package

pk-serialize.

Source

serialize.lisp.

Direct methods
Direct slots
Slot: null-slot
Readers

null-slot.

Writers

(setf null-slot).

Slot: array-slot
Initform

(make-array (quote (2 3 4)))

Readers

array-slot.

Writers

(setf array-slot).

Slot: hash-slot
Initform

(make-hash-table)

Readers

hash-slot.

Writers

(setf hash-slot).

Slot: func-slot
Initform

(function +)

Readers

func-slot.

Writers

(setf func-slot).

Slot: list-slot
Initform

(quote (pk-serialize::l1 pk-serialize::l2 pk-serialize::l3))

Readers

list-slot.

Writers

(setf list-slot).

Slot: string-slot
Initform

"test string"

Readers

string-slot.

Writers

(setf string-slot).

Slot: path-slot
Initform

(make-pathname :name "test" :type "txt" :defaults (truename "~/"))

Readers

path-slot.

Writers

(setf path-slot).

Slot: class-alloc-slot
Allocation

:class

Readers

class-alloc-slot.

Writers

(setf class-alloc-slot).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   F   G   H   I   L   M   N   P   R   S   T   V  
Index Entry  Section

(
(setf array-slot): Private generic functions
(setf array-slot): Private generic functions
(setf class-alloc-slot): Private generic functions
(setf class-alloc-slot): Private generic functions
(setf func-slot): Private generic functions
(setf func-slot): Private generic functions
(setf hash-slot): Private generic functions
(setf hash-slot): Private generic functions
(setf list-slot): Private generic functions
(setf list-slot): Private generic functions
(setf null-slot): Private generic functions
(setf null-slot): Private generic functions
(setf path-slot): Private generic functions
(setf path-slot): Private generic functions
(setf string-slot): Private generic functions
(setf string-slot): Private generic functions
(setf test-struct-ts1): Private ordinary functions
(setf test-struct-ts2): Private ordinary functions

A
all-superclasses: Private generic functions
all-superclasses: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
alloc-form-for: Private generic functions
array-contents: Private generic functions
array-contents: Private generic functions
array-equal: Private ordinary functions
array-slot: Private generic functions
array-slot: Private generic functions

C
class-alloc-slot: Private generic functions
class-alloc-slot: Private generic functions
class-class-slots: Private generic functions
class-class-slots: Private generic functions
class-instance-slots: Private generic functions
class-instance-slots: Private generic functions
constructor-name: Private generic functions
constructor-name: Private generic functions
constructor-name-with-package: Private generic functions
constructor-name-with-package: Private generic functions
copy-test-struct: Private ordinary functions

D
dotted-pair-p: Private ordinary functions
dump-to-file: Public generic functions
dump-to-file: Public generic functions

F
func-slot: Private generic functions
func-slot: Private generic functions
Function, (setf test-struct-ts1): Private ordinary functions
Function, (setf test-struct-ts2): Private ordinary functions
Function, array-equal: Private ordinary functions
Function, copy-test-struct: Private ordinary functions
Function, dotted-pair-p: Private ordinary functions
Function, get-ref: Private ordinary functions
Function, hash-equal: Private ordinary functions
Function, increment-paren-num: Private ordinary functions
Function, init-for-dump: Private ordinary functions
Function, init-for-restore: Private ordinary functions
Function, make-test-struct: Private ordinary functions
Function, pretty-init-args: Private ordinary functions
Function, pure-list-p: Private ordinary functions
Function, rename-data: Private ordinary functions
Function, ser-test: Private ordinary functions
Function, set-slot-vals: Private ordinary functions
Function, test-struct-p: Private ordinary functions
Function, test-struct-ts1: Private ordinary functions
Function, test-struct-ts2: Private ordinary functions
Function, val-for-init: Private ordinary functions

G
Generic Function, (setf array-slot): Private generic functions
Generic Function, (setf class-alloc-slot): Private generic functions
Generic Function, (setf func-slot): Private generic functions
Generic Function, (setf hash-slot): Private generic functions
Generic Function, (setf list-slot): Private generic functions
Generic Function, (setf null-slot): Private generic functions
Generic Function, (setf path-slot): Private generic functions
Generic Function, (setf string-slot): Private generic functions
Generic Function, all-superclasses: Private generic functions
Generic Function, alloc-form-for: Private generic functions
Generic Function, array-contents: Private generic functions
Generic Function, array-slot: Private generic functions
Generic Function, class-alloc-slot: Private generic functions
Generic Function, class-class-slots: Private generic functions
Generic Function, class-instance-slots: Private generic functions
Generic Function, constructor-name: Private generic functions
Generic Function, constructor-name-with-package: Private generic functions
Generic Function, dump-to-file: Public generic functions
Generic Function, func-slot: Private generic functions
Generic Function, hash-slot: Private generic functions
Generic Function, init: Private generic functions
Generic Function, init-form-for: Private generic functions
Generic Function, list-slot: Private generic functions
Generic Function, name-with-package: Private generic functions
Generic Function, null-slot: Private generic functions
Generic Function, path-slot: Private generic functions
Generic Function, replace-refs-in: Private generic functions
Generic Function, restore-from-file: Public generic functions
Generic Function, slots-to-dump: Public generic functions
Generic Function, slots-to-not-dump: Public generic functions
Generic Function, string-slot: Private generic functions
get-ref: Private ordinary functions

H
hash-equal: Private ordinary functions
hash-slot: Private generic functions
hash-slot: Private generic functions

I
increment-paren-num: Private ordinary functions
init: Private generic functions
init: Private generic functions
init: Private generic functions
init: Private generic functions
init: Private generic functions
init: Private generic functions
init: Private generic functions
init: Private generic functions
init-for-dump: Private ordinary functions
init-for-restore: Private ordinary functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
init-form-for: Private generic functions
initialize-instance: Public standalone methods

L
list-slot: Private generic functions
list-slot: Private generic functions

M
make-test-struct: Private ordinary functions
Method, (setf array-slot): Private generic functions
Method, (setf class-alloc-slot): Private generic functions
Method, (setf func-slot): Private generic functions
Method, (setf hash-slot): Private generic functions
Method, (setf list-slot): Private generic functions
Method, (setf null-slot): Private generic functions
Method, (setf path-slot): Private generic functions
Method, (setf string-slot): Private generic functions
Method, all-superclasses: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, alloc-form-for: Private generic functions
Method, array-contents: Private generic functions
Method, array-slot: Private generic functions
Method, class-alloc-slot: Private generic functions
Method, class-class-slots: Private generic functions
Method, class-instance-slots: Private generic functions
Method, constructor-name: Private generic functions
Method, constructor-name-with-package: Private generic functions
Method, dump-to-file: Public generic functions
Method, func-slot: Private generic functions
Method, hash-slot: Private generic functions
Method, init: Private generic functions
Method, init: Private generic functions
Method, init: Private generic functions
Method, init: Private generic functions
Method, init: Private generic functions
Method, init: Private generic functions
Method, init: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, init-form-for: Private generic functions
Method, initialize-instance: Public standalone methods
Method, list-slot: Private generic functions
Method, name-with-package: Private generic functions
Method, name-with-package: Private generic functions
Method, name-with-package: Private generic functions
Method, name-with-package: Private generic functions
Method, null-slot: Private generic functions
Method, path-slot: Private generic functions
Method, replace-refs-in: Private generic functions
Method, replace-refs-in: Private generic functions
Method, replace-refs-in: Private generic functions
Method, restore-from-file: Public generic functions
Method, slots-to-dump: Public generic functions
Method, slots-to-not-dump: Public generic functions
Method, string-slot: Private generic functions

N
name-with-package: Private generic functions
name-with-package: Private generic functions
name-with-package: Private generic functions
name-with-package: Private generic functions
name-with-package: Private generic functions
null-slot: Private generic functions
null-slot: Private generic functions

P
path-slot: Private generic functions
path-slot: Private generic functions
pretty-init-args: Private ordinary functions
pure-list-p: Private ordinary functions

R
rename-data: Private ordinary functions
replace-refs-in: Private generic functions
replace-refs-in: Private generic functions
replace-refs-in: Private generic functions
replace-refs-in: Private generic functions
restore-from-file: Public generic functions
restore-from-file: Public generic functions

S
ser-test: Private ordinary functions
set-slot-vals: Private ordinary functions
slots-to-dump: Public generic functions
slots-to-dump: Public generic functions
slots-to-not-dump: Public generic functions
slots-to-not-dump: Public generic functions
string-slot: Private generic functions
string-slot: Private generic functions

T
test-struct-p: Private ordinary functions
test-struct-ts1: Private ordinary functions
test-struct-ts2: Private ordinary functions

V
val-for-init: Private ordinary functions