The cl-netstring+ Reference Manual

This is the cl-netstring+ Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:17:38 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-netstring+

A simple library for sending and receiving messages with a netstring-like encoding.

Author

Matthew Stickney <>

License

MIT

Dependencies
  • trivial-utf-8 (system).
  • flexi-streams (system).
Source

cl-netstring+.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-netstring+/cl-netstring+.asd

Source

cl-netstring+.asd.

Parent Component

cl-netstring+ (system).

ASDF Systems

cl-netstring+.


3.1.2 cl-netstring+/package.lisp

Source

cl-netstring+.asd.

Parent Component

cl-netstring+ (system).

Packages

cl-netstring+.


3.1.3 cl-netstring+/netstring-plus.lisp

Dependency

package.lisp (file).

Source

cl-netstring+.asd.

Parent Component

cl-netstring+ (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-netstring+

Source

package.lisp.

Nickname

nsp

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 Macros

Macro: data (sequence)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Macro: str (string)
Package

cl-netstring+.

Source

netstring-plus.lisp.


5.1.2 Ordinary functions

Function: make-decoder-state (&rest args &key state size data)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: netstring-bytes (&rest data)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: netstring-bytes* (datae)

Return a netstring encoding for the concatenation of DATAE.

Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: netstring-data (bytes)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: next-read-size (state)

Return the size of the next chunk of data that STATE expects as an efficiency hint.

Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: pump-byte! (state byte)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: pump-stream! (stream state &key count bytes)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: pump-vector! (vector state &key start end count)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: read-netstring-data (stream)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: write-netstring-bytes (stream &rest datae)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: write-netstring-bytes* (stream datae)
Package

cl-netstring+.

Source

netstring-plus.lisp.


5.1.3 Standalone methods

Method: print-object ((object decoder-state) stream)
Source

netstring-plus.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: add-data-byte! (state byte)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: add-header-digit! (state n)
Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: ascii-hex-digit-p (code)

Return T if CODE is the ASCII value for a hexadecimal digit, NIL otherwise.

Package

cl-netstring+.

Source

netstring-plus.lisp.

Function: transition-state! (state to-state)
Package

cl-netstring+.

Source

netstring-plus.lisp.


5.2.2 Generic functions

Generic Reader: expected-size (condition)
Package

cl-netstring+.

Methods
Reader Method: expected-size ((condition too-much-data))
Source

netstring-plus.lisp.

Target Slot

expected-size.

Generic Reader: found-char (condition)
Package

cl-netstring+.

Methods
Reader Method: found-char ((condition too-much-data))
Source

netstring-plus.lisp.

Target Slot

found-char.

Generic Reader: invalid-char (condition)
Package

cl-netstring+.

Methods
Reader Method: invalid-char ((condition invalid-header-character))
Source

netstring-plus.lisp.

Target Slot

invalid-char.

Generic Reader: msg-data (object)
Package

cl-netstring+.

Methods
Reader Method: msg-data ((decoder-state decoder-state))

automatically generated reader method

Source

netstring-plus.lisp.

Target Slot

message-data.

Generic Writer: (setf msg-data) (object)
Package

cl-netstring+.

Methods
Writer Method: (setf msg-data) ((decoder-state decoder-state))

automatically generated writer method

Source

netstring-plus.lisp.

Target Slot

message-data.

Generic Reader: size (object)
Package

cl-netstring+.

Methods
Reader Method: size ((decoder-state decoder-state))

automatically generated reader method

Source

netstring-plus.lisp.

Target Slot

data-size.

Generic Writer: (setf size) (object)
Package

cl-netstring+.

Methods
Writer Method: (setf size) ((decoder-state decoder-state))

automatically generated writer method

Source

netstring-plus.lisp.

Target Slot

data-size.

Generic Reader: state (object)
Package

cl-netstring+.

Methods
Reader Method: state ((decoder-state decoder-state))

automatically generated reader method

Source

netstring-plus.lisp.

Target Slot

state.

Generic Writer: (setf state) (object)
Package

cl-netstring+.

Methods
Writer Method: (setf state) ((decoder-state decoder-state))

automatically generated writer method

Source

netstring-plus.lisp.

Target Slot

state.


5.2.3 Conditions

Condition: empty-header

Condition representing a netstring header with no size digits.

Package

cl-netstring+.

Source

netstring-plus.lisp.

Direct superclasses

netstring-parse-error.

Condition: invalid-header-character

Condition representing an invalid character in a netstring header.

Package

cl-netstring+.

Source

netstring-plus.lisp.

Direct superclasses

netstring-parse-error.

Direct methods

invalid-char.

Direct slots
Slot: invalid-char
Initargs

:char

Readers

invalid-char.

Writers

This slot is read-only.

Condition: netstring-parse-error

Generic condition representing all netstring parse errors.

Package

cl-netstring+.

Source

netstring-plus.lisp.

Direct superclasses

error.

Direct subclasses
Condition: too-much-data

Condition representing a missing terminator after the data bytes.

Package

cl-netstring+.

Source

netstring-plus.lisp.

Direct superclasses

netstring-parse-error.

Direct methods
Direct slots
Slot: expected-size
Initargs

:expected-size

Readers

expected-size.

Writers

This slot is read-only.

Slot: found-char
Initargs

:found

Readers

found-char.

Writers

This slot is read-only.


5.2.4 Classes

Class: decoder-state
Package

cl-netstring+.

Source

netstring-plus.lisp.

Direct methods
Direct Default Initargs
InitargValue
:stateinitial
:size0
:datanil
Direct slots
Slot: state
Initargs

:state

Readers

state.

Writers

(setf state).

Slot: data-size
Initargs

:size

Readers

size.

Writers

(setf size).

Slot: message-data
Initargs

:data

Readers

msg-data.

Writers

(setf msg-data).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   D   E   F   G   I   M   N   P   R   S   T   W  
Index Entry  Section

(
(setf msg-data): Private generic functions
(setf msg-data): Private generic functions
(setf size): Private generic functions
(setf size): Private generic functions
(setf state): Private generic functions
(setf state): Private generic functions

A
add-data-byte!: Private ordinary functions
add-header-digit!: Private ordinary functions
ascii-hex-digit-p: Private ordinary functions

D
data: Public macros

E
expected-size: Private generic functions
expected-size: Private generic functions

F
found-char: Private generic functions
found-char: Private generic functions
Function, add-data-byte!: Private ordinary functions
Function, add-header-digit!: Private ordinary functions
Function, ascii-hex-digit-p: Private ordinary functions
Function, make-decoder-state: Public ordinary functions
Function, netstring-bytes: Public ordinary functions
Function, netstring-bytes*: Public ordinary functions
Function, netstring-data: Public ordinary functions
Function, next-read-size: Public ordinary functions
Function, pump-byte!: Public ordinary functions
Function, pump-stream!: Public ordinary functions
Function, pump-vector!: Public ordinary functions
Function, read-netstring-data: Public ordinary functions
Function, transition-state!: Private ordinary functions
Function, write-netstring-bytes: Public ordinary functions
Function, write-netstring-bytes*: Public ordinary functions

G
Generic Function, (setf msg-data): Private generic functions
Generic Function, (setf size): Private generic functions
Generic Function, (setf state): Private generic functions
Generic Function, expected-size: Private generic functions
Generic Function, found-char: Private generic functions
Generic Function, invalid-char: Private generic functions
Generic Function, msg-data: Private generic functions
Generic Function, size: Private generic functions
Generic Function, state: Private generic functions

I
invalid-char: Private generic functions
invalid-char: Private generic functions

M
Macro, data: Public macros
Macro, str: Public macros
make-decoder-state: Public ordinary functions
Method, (setf msg-data): Private generic functions
Method, (setf size): Private generic functions
Method, (setf state): Private generic functions
Method, expected-size: Private generic functions
Method, found-char: Private generic functions
Method, invalid-char: Private generic functions
Method, msg-data: Private generic functions
Method, print-object: Public standalone methods
Method, size: Private generic functions
Method, state: Private generic functions
msg-data: Private generic functions
msg-data: Private generic functions

N
netstring-bytes: Public ordinary functions
netstring-bytes*: Public ordinary functions
netstring-data: Public ordinary functions
next-read-size: Public ordinary functions

P
print-object: Public standalone methods
pump-byte!: Public ordinary functions
pump-stream!: Public ordinary functions
pump-vector!: Public ordinary functions

R
read-netstring-data: Public ordinary functions

S
size: Private generic functions
size: Private generic functions
state: Private generic functions
state: Private generic functions
str: Public macros

T
transition-state!: Private ordinary functions

W
write-netstring-bytes: Public ordinary functions
write-netstring-bytes*: Public ordinary functions