The cl-toml Reference Manual

Table of Contents

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

The cl-toml Reference Manual

This is the cl-toml Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:25:53 2018 GMT+0.


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

1 Introduction

cl-toml

Build Status

toml 0.4.0 parser and encoder

Usage

(defparameter *example-text*
  "# This is a TOML document. Boom.
title = \"TOML Example\"
[owner]
name = \"Lance Uppercut\"
dob = 1979-05-27T07:32:00-08:00 # First class dates? Why not?
")

(cl-toml:parse *example-text*)
=> #<EQUAL Hash Table{5} 40205D45A3>


(cl-toml:parse *example-text* :table-as :alist)
=> (("owner" ("dob" . @1979-05-27T15:32:00.000000Z) ("name" . "Lance Uppercut"))
    ("title" . "TOML Example"))

(cl-toml:encode '(("owner" ("dob" . @1979-05-27T15:32:00.000000Z) ("name" . "Lance Uppercut"))
                  ("title" . "TOML Example")))

"title" = "TOML Example"
[owner]
"dob" = 1979-05-27T15:32:00.000000Z
"name" = "Lance Uppercut"

License

MIT


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 cl-toml

Author

cxxxr

License

MIT

Description

TOML v0.4.0 parser and encoder

Dependencies
Source

cl-toml.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.


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

3.1 Lisp


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

3.1.1 cl-toml.asd

Location

cl-toml.asd

Systems

cl-toml (system)


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

3.1.2 cl-toml/package.lisp

Parent

cl-toml (system)

Location

package.lisp

Packages

cl-toml


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

3.1.3 cl-toml/util.lisp

Dependency

package.lisp (file)

Parent

cl-toml (system)

Location

util.lisp

Internal Definitions

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

3.1.4 cl-toml/parse.lisp

Dependency

util.lisp (file)

Parent

cl-toml (system)

Location

parse.lisp

Exported Definitions
Internal Definitions

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

3.1.5 cl-toml/encode.lisp

Dependency

parse.lisp (file)

Parent

cl-toml (system)

Location

encode.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-toml

Source

package.lisp (file)

Use List
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


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

5.1.1 Functions

Function: parse STRING &key (ARRAY-AS *ARRAY-AS*) (TABLE-AS *TABLE-AS*)
Package

cl-toml

Source

parse.lisp (file)

Function: parse-file FILENAME
Package

cl-toml

Source

parse.lisp (file)


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

5.1.2 Generic functions

Generic Function: encode VALUE &optional STREAM
Package

cl-toml

Source

encode.lisp (file)

Methods
Method: encode (VALUE vector) &optional STREAM
Method: encode (VALUE list) &optional STREAM
Method: encode (VALUE hash-table) &optional STREAM
Method: encode (VALUE (eql false)) &optional STREAM
Method: encode (VALUE (eql 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 Internal definitions


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

5.2.1 Special variables

Special Variable: *array-as*
Package

cl-toml

Source

parse.lisp (file)

Special Variable: *char-replacement*
Package

cl-toml

Source

encode.lisp (file)

Special Variable: *inline-value-p*
Package

cl-toml

Source

encode.lisp (file)

Special Variable: *table-as*
Package

cl-toml

Source

parse.lisp (file)

Special Variable: *table-name-stack*
Package

cl-toml

Source

encode.lisp (file)


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

5.2.2 Macros

Macro: do-sequence (VAR SEQUENCE) &body BODY
Package

cl-toml

Source

util.lisp (file)

Macro: with-aggregate (STREAM OPENING-CHAR CLOSING-CHAR) &body BODY
Package

cl-toml

Source

encode.lisp (file)


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

5.2.3 Functions

Function: alist-to-table ALIST
Package

cl-toml

Source

parse.lisp (file)

Function: array-p X
Package

cl-toml

Source

encode.lisp (file)

Function: as-table-p X
Package

cl-toml

Source

parse.lisp (file)

Function: bare-key-character-p C
Package

cl-toml

Source

parse.lisp (file)

Function: convert-escape-sequence STRING MULTILINE-P
Package

cl-toml

Source

parse.lisp (file)

Function: encode-inline-table ITER STREAM
Package

cl-toml

Source

encode.lisp (file)

Function: encode-key-value KEY VALUE STREAM
Package

cl-toml

Source

encode.lisp (file)

Function: encode-sequence SEQUENCE STREAM
Package

cl-toml

Source

encode.lisp (file)

Function: encode-table ITER STREAM
Package

cl-toml

Source

encode.lisp (file)

Function: linked-table NAMES TABLE LAST-VALUE ARRAYP
Package

cl-toml

Source

parse.lisp (file)

Function: list-to-toml-array LIST
Package

cl-toml

Source

parse.lisp (file)

Function: list-to-vector LIST
Package

cl-toml

Source

util.lisp (file)

Function: literal-string-char-p CHAR
Package

cl-toml

Source

parse.lisp (file)

Function: make-adjustable-string ()
Package

cl-toml

Source

util.lisp (file)

Function: make-adjustable-vector &rest ARGS
Package

cl-toml

Source

util.lisp (file)

Function: make-alist-iterate ALIST
Package

cl-toml

Source

util.lisp (file)

Function: make-plist-iterate PLIST
Package

cl-toml

Source

util.lisp (file)

Function: make-table ()
Package

cl-toml

Source

parse.lisp (file)

Function: make-toml-array ()
Package

cl-toml

Source

parse.lisp (file)

Function: string-char-p CHAR
Package

cl-toml

Source

parse.lisp (file)

Function: table-array-p X
Package

cl-toml

Source

encode.lisp (file)

Function: table-get TABLE KEY
Package

cl-toml

Source

parse.lisp (file)

Function: table-put TABLE KEY VALUE
Package

cl-toml

Source

parse.lisp (file)

Function: table-value-p X
Package

cl-toml

Source

encode.lisp (file)

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

cl-toml

Source

parse.lisp (file)

Function: toml-array-push ARRAY VALUE
Package

cl-toml

Source

parse.lisp (file)

Function: transform-string-contents LIST MULTILINE-P
Package

cl-toml

Source

parse.lisp (file)

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

cl-toml

Source

util.lisp (file)

Function: word-string-p STRING
Package

cl-toml

Source

encode.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-toml.asd: The cl-toml<dot>asd file
cl-toml/encode.lisp: The cl-toml/encode<dot>lisp file
cl-toml/package.lisp: The cl-toml/package<dot>lisp file
cl-toml/parse.lisp: The cl-toml/parse<dot>lisp file
cl-toml/util.lisp: The cl-toml/util<dot>lisp file

F
File, Lisp, cl-toml.asd: The cl-toml<dot>asd file
File, Lisp, cl-toml/encode.lisp: The cl-toml/encode<dot>lisp file
File, Lisp, cl-toml/package.lisp: The cl-toml/package<dot>lisp file
File, Lisp, cl-toml/parse.lisp: The cl-toml/parse<dot>lisp file
File, Lisp, cl-toml/util.lisp: The cl-toml/util<dot>lisp file

L
Lisp File, cl-toml.asd: The cl-toml<dot>asd file
Lisp File, cl-toml/encode.lisp: The cl-toml/encode<dot>lisp file
Lisp File, cl-toml/package.lisp: The cl-toml/package<dot>lisp file
Lisp File, cl-toml/parse.lisp: The cl-toml/parse<dot>lisp file
Lisp File, cl-toml/util.lisp: The cl-toml/util<dot>lisp file

Jump to:   C   F   L  

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): Internal functions
(setf vector-last): Internal functions

A
alist-to-table: Internal functions
array-p: Internal functions
as-table-p: Internal functions

B
bare-key-character-p: Internal functions

C
convert-escape-sequence: Internal functions

D
do-sequence: Internal macros

E
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode: Exported generic functions
encode-inline-table: Internal functions
encode-key-value: Internal functions
encode-sequence: Internal functions
encode-table: Internal functions

F
Function, (setf toml-array-last): Internal functions
Function, (setf vector-last): Internal functions
Function, alist-to-table: Internal functions
Function, array-p: Internal functions
Function, as-table-p: Internal functions
Function, bare-key-character-p: Internal functions
Function, convert-escape-sequence: Internal functions
Function, encode-inline-table: Internal functions
Function, encode-key-value: Internal functions
Function, encode-sequence: Internal functions
Function, encode-table: Internal functions
Function, linked-table: Internal functions
Function, list-to-toml-array: Internal functions
Function, list-to-vector: Internal functions
Function, literal-string-char-p: Internal functions
Function, make-adjustable-string: Internal functions
Function, make-adjustable-vector: Internal functions
Function, make-alist-iterate: Internal functions
Function, make-plist-iterate: Internal functions
Function, make-table: Internal functions
Function, make-toml-array: Internal functions
Function, parse: Exported functions
Function, parse-file: Exported functions
Function, string-char-p: Internal functions
Function, table-array-p: Internal functions
Function, table-get: Internal functions
Function, table-put: Internal functions
Function, table-value-p: Internal functions
Function, toml-array-last: Internal functions
Function, toml-array-push: Internal functions
Function, transform-string-contents: Internal functions
Function, vector-last: Internal functions
Function, word-string-p: Internal functions

G
Generic Function, encode: Exported generic functions

L
linked-table: Internal functions
list-to-toml-array: Internal functions
list-to-vector: Internal functions
literal-string-char-p: Internal functions

M
Macro, do-sequence: Internal macros
Macro, with-aggregate: Internal macros
make-adjustable-string: Internal functions
make-adjustable-vector: Internal functions
make-alist-iterate: Internal functions
make-plist-iterate: Internal functions
make-table: Internal functions
make-toml-array: Internal functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions
Method, encode: Exported generic functions

P
parse: Exported functions
parse-file: Exported functions

S
string-char-p: Internal functions

T
table-array-p: Internal functions
table-get: Internal functions
table-put: Internal functions
table-value-p: Internal functions
toml-array-last: Internal functions
toml-array-push: Internal functions
transform-string-contents: Internal functions

V
vector-last: Internal functions

W
with-aggregate: Internal macros
word-string-p: Internal functions

Jump to:   (  
A   B   C   D   E   F   G   L   M   P   S   T   V   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*array-as*: Internal special variables
*char-replacement*: Internal special variables
*inline-value-p*: Internal special variables
*table-as*: Internal special variables
*table-name-stack*: Internal special variables

S
Special Variable, *array-as*: Internal special variables
Special Variable, *char-replacement*: Internal special variables
Special Variable, *inline-value-p*: Internal special variables
Special Variable, *table-as*: Internal special variables
Special Variable, *table-name-stack*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-toml: The cl-toml system
cl-toml: The cl-toml package

P
Package, cl-toml: The cl-toml package

S
System, cl-toml: The cl-toml system

Jump to:   C   P   S