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

The cl-toml Reference Manual

This is the cl-toml Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:27:16 2025 GMT+0.

Table of Contents

Next: , Previous: , Up: The cl-toml Reference Manual   [Contents][Index]

1 Introduction

Next: , Previous: , Up: The cl-toml Reference Manual   [Contents][Index]

2 Systems

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

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

2.1 cl-toml

TOML v0.4.0 parser and encoder

Author

cxxxr

License

MIT

Dependencies
  • alexandria (system).
  • trivial-types (system).
  • esrap (system).
  • local-time (system).
Source

cl-toml.asd.

Child Components

Next: , Previous: , Up: The cl-toml Reference Manual   [Contents][Index]

3 Files

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

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

3.1 Lisp

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

3.1.1 cl-toml/cl-toml.asd

Source

cl-toml.asd.

Parent Component

cl-toml (system).

ASDF Systems

cl-toml.

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

3.1.2 cl-toml/package.lisp

Source

cl-toml.asd.

Parent Component

cl-toml (system).

Packages

cl-toml.

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

3.1.3 cl-toml/util.lisp

Dependency

package.lisp (file).

Source

cl-toml.asd.

Parent Component

cl-toml (system).

Internals

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

3.1.4 cl-toml/types.lisp

Dependency

util.lisp (file).

Source

cl-toml.asd.

Parent Component

cl-toml (system).

Internals

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

3.1.5 cl-toml/parse.lisp

Dependency

types.lisp (file).

Source

cl-toml.asd.

Parent Component

cl-toml (system).

Public Interface
Internals

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

3.1.6 cl-toml/encode.lisp

Dependency

parse.lisp (file).

Source

cl-toml.asd.

Parent Component

cl-toml (system).

Public Interface
Internals

Next: , Previous: , Up: The cl-toml Reference Manual   [Contents][Index]

4 Packages

Packages are listed by definition order.

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

4.1 cl-toml

Source

package.lisp.

Use List
  • common-lisp.
  • esrap.
Public Interface
Internals

Next: , Previous: , Up: The cl-toml Reference Manual   [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 Public Interface

Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.1 Ordinary functions

Function: encode-literal-string (string &optional stream)
Package

cl-toml.

Source

encode.lisp.

Function: parse (string &key array-as table-as)
Package

cl-toml.

Source

parse.lisp.

Function: parse-file (filename &rest args &key array-as table-as)
Package

cl-toml.

Source

parse.lisp.

Previous: , Up: Public Interface   [Contents][Index]

5.1.2 Generic functions

Generic Function: encode (value &optional stream)
Package

cl-toml.

Source

encode.lisp.

Methods
Method: encode ((value vector) &optional stream)
Method: encode ((value list) &optional stream)
Method: encode ((value hash-table) &optional stream)
Method: encode ((value (eql cl-toml:false)) &optional stream)
Method: encode ((value (eql cl-toml:true)) &optional stream)
Method: encode ((value (eql t)) &optional stream)
Method: encode ((value string) &optional stream)
Method: encode ((value timestamp) &optional stream)
Method: encode ((value integer) &optional stream)
Method: encode ((value float) &optional stream)
Method: encode ((value ratio) &optional stream)

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

5.2 Internals

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

5.2.1 Special variables

Special Variable: *array-as*
Package

cl-toml.

Source

parse.lisp.

Special Variable: *char-replacement*
Package

cl-toml.

Source

encode.lisp.

Special Variable: *inline-value-p*
Package

cl-toml.

Source

encode.lisp.

Special Variable: *table-as*
Package

cl-toml.

Source

parse.lisp.

Special Variable: *table-name-stack*
Package

cl-toml.

Source

encode.lisp.

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

5.2.2 Macros

Macro: do-sequence ((var sequence) &body body)
Package

cl-toml.

Source

util.lisp.

Macro: with-aggregate ((stream opening-char closing-char) &body body)
Package

cl-toml.

Source

encode.lisp.

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

5.2.3 Ordinary functions

Function: alist-put-end (table key value)
Package

cl-toml.

Source

util.lisp.

Function: alist-to-table (alist)
Package

cl-toml.

Source

parse.lisp.

Function: array-p (x)
Package

cl-toml.

Source

encode.lisp.

Function: as-table-p (x)
Package

cl-toml.

Source

parse.lisp.

Function: bare-key-character-p (c)
Package

cl-toml.

Source

types.lisp.

Function: bare-key-p (x)
Package

cl-toml.

Source

types.lisp.

Function: convert-escape-sequence (string multiline-p)
Package

cl-toml.

Source

parse.lisp.

Function: convert-to-simple-string (string)
Package

cl-toml.

Source

parse.lisp.

Function: encode-inline-table (iter stream)
Package

cl-toml.

Source

encode.lisp.

Function: encode-key-value (key value stream)
Package

cl-toml.

Source

encode.lisp.

Function: encode-sequence (sequence stream)
Package

cl-toml.

Source

encode.lisp.

Function: encode-table (iter stream)
Package

cl-toml.

Source

encode.lisp.

Function: linked-table (names table last-value arrayp)
Package

cl-toml.

Source

parse.lisp.

Function: list-to-toml-array (list)
Package

cl-toml.

Source

parse.lisp.

Function: list-to-vector (list)
Package

cl-toml.

Source

util.lisp.

Function: literal-string-char-p (char)
Package

cl-toml.

Source

types.lisp.

Function: literal-string-p (object)
Package

cl-toml.

Source

types.lisp.

Function: make-adjustable-string ()
Package

cl-toml.

Source

util.lisp.

Function: make-adjustable-vector (&rest args)
Package

cl-toml.

Source

util.lisp.

Function: make-alist-iterate (alist)
Package

cl-toml.

Source

util.lisp.

Function: make-plist-iterate (plist)
Package

cl-toml.

Source

util.lisp.

Function: make-table ()
Package

cl-toml.

Source

parse.lisp.

Function: make-toml-array ()
Package

cl-toml.

Source

parse.lisp.

Function: string-char-p (char)
Package

cl-toml.

Source

parse.lisp.

Function: table-array-p (x)
Package

cl-toml.

Source

encode.lisp.

Function: table-get (table key)
Package

cl-toml.

Source

parse.lisp.

Function: table-put (table key value)
Package

cl-toml.

Source

parse.lisp.

Function: table-value-p (x)
Package

cl-toml.

Source

encode.lisp.

Function: toml-array-last (array)
Package

cl-toml.

Source

parse.lisp.

Function: (setf toml-array-last) (array)
Package

cl-toml.

Source

parse.lisp.

Function: toml-array-push (array value)
Package

cl-toml.

Source

parse.lisp.

Function: transform-string-contents (list multiline-p)
Package

cl-toml.

Source

parse.lisp.

Function: vector-last (vector)
Package

cl-toml.

Source

util.lisp.

Function: (setf vector-last) (vector)
Package

cl-toml.

Source

util.lisp.

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

5.2.4 Types

Type: literal-string ()
Package

cl-toml.

Source

types.lisp.

Previous: , Up: The cl-toml Reference Manual   [Contents][Index]

Appendix A Indexes

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

A.1 Concepts

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

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   L   M   P   S   T   V   W  
Index Entry  Section
(
(setf toml-array-last): Private ordinary functions
(setf vector-last): Private ordinary functions
A
alist-put-end: Private ordinary functions
alist-to-table: Private ordinary functions
array-p: Private ordinary functions
as-table-p: Private ordinary functions
B
bare-key-character-p: Private ordinary functions
bare-key-p: Private ordinary functions
C
convert-escape-sequence: Private ordinary functions
convert-to-simple-string: Private ordinary functions
D
do-sequence: Private macros
E
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode: Public generic functions
encode-inline-table: Private ordinary functions
encode-key-value: Private ordinary functions
encode-literal-string: Public ordinary functions
encode-sequence: Private ordinary functions
encode-table: Private ordinary functions
F
Function, (setf toml-array-last): Private ordinary functions
Function, (setf vector-last): Private ordinary functions
Function, alist-put-end: Private ordinary functions
Function, alist-to-table: Private ordinary functions
Function, array-p: Private ordinary functions
Function, as-table-p: Private ordinary functions
Function, bare-key-character-p: Private ordinary functions
Function, bare-key-p: Private ordinary functions
Function, convert-escape-sequence: Private ordinary functions
Function, convert-to-simple-string: Private ordinary functions
Function, encode-inline-table: Private ordinary functions
Function, encode-key-value: Private ordinary functions
Function, encode-literal-string: Public ordinary functions
Function, encode-sequence: Private ordinary functions
Function, encode-table: Private ordinary functions
Function, linked-table: Private ordinary functions
Function, list-to-toml-array: Private ordinary functions
Function, list-to-vector: Private ordinary functions
Function, literal-string-char-p: Private ordinary functions
Function, literal-string-p: Private ordinary functions
Function, make-adjustable-string: Private ordinary functions
Function, make-adjustable-vector: Private ordinary functions
Function, make-alist-iterate: Private ordinary functions
Function, make-plist-iterate: Private ordinary functions
Function, make-table: Private ordinary functions
Function, make-toml-array: Private ordinary functions
Function, parse: Public ordinary functions
Function, parse-file: Public ordinary functions
Function, string-char-p: Private ordinary functions
Function, table-array-p: Private ordinary functions
Function, table-get: Private ordinary functions
Function, table-put: Private ordinary functions
Function, table-value-p: Private ordinary functions
Function, toml-array-last: Private ordinary functions
Function, toml-array-push: Private ordinary functions
Function, transform-string-contents: Private ordinary functions
Function, vector-last: Private ordinary functions
G
Generic Function, encode: Public generic functions
L
linked-table: Private ordinary functions
list-to-toml-array: Private ordinary functions
list-to-vector: Private ordinary functions
literal-string-char-p: Private ordinary functions
literal-string-p: Private ordinary functions
M
Macro, do-sequence: Private macros
Macro, with-aggregate: Private macros
make-adjustable-string: Private ordinary functions
make-adjustable-vector: Private ordinary functions
make-alist-iterate: Private ordinary functions
make-plist-iterate: Private ordinary functions
make-table: Private ordinary functions
make-toml-array: Private ordinary functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
Method, encode: Public generic functions
P
parse: Public ordinary functions
parse-file: Public ordinary functions
S
string-char-p: Private ordinary functions
T
table-array-p: Private ordinary functions
table-get: Private ordinary functions
table-put: Private ordinary functions
table-value-p: Private ordinary functions
toml-array-last: Private ordinary functions
toml-array-push: Private ordinary functions
transform-string-contents: Private ordinary functions
V
vector-last: Private ordinary functions
W
with-aggregate: Private macros
Jump to:   (  
A   B   C   D   E   F   G   L   M   P   S   T   V   W