The cl-netstrings Reference Manual

Table of Contents

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

The cl-netstrings Reference Manual

This is the cl-netstrings Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:26:58 2018 GMT+0.


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

1 Introduction

See doc/index.html.


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-netstrings

Maintainer

Daniel Janus

Author

Daniel Janus

License

MIT

Description

A library for handling netstrings as described in http://cr.yp.to/proto/netstrings.txt.

Version

0.1

Dependencies
Source

cl-netstrings.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 cl-netstrings/src

Parent

cl-netstrings (system)

Location

src/

Component

netstrings.lisp (file)


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

4 Files

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


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

4.1 Lisp


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

4.1.1 cl-netstrings.asd

Location

cl-netstrings.asd

Systems

cl-netstrings (system)

Packages

netstrings-asd


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

4.1.2 cl-netstrings/src/netstrings.lisp

Parent

src (module)

Location

src/netstrings.lisp

Packages

netstrings

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 netstrings-asd

Source

cl-netstrings.asd

Use List

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

5.2 netstrings

Source

netstrings.lisp (file)

Nickname

cl-netstrings

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Functions

Function: read-netstring STREAM &optional ENCODING

Reads a netstring from STREAM. STREAM must be a binary input stream that has an element type (UNSIGNED-BYTE 8). After reading, the sequence of bytes is converted to an ordinary lisp string using ENCODING (see the documentation of ARNESI:OCTETS-TO-STRING for a list of available encodings).

Package

netstrings

Source

netstrings.lisp (file)

Function: write-netstring STRING STREAM &optional ENCODING

Writes a STRING to STREAM as a netstring. STREAM must be a binary output stream that has an element type (UNSIGNED-BYTE 8). The string is converted to a sequence of bytes using ENCODING and then written to the stream. See the documentation of ARNESI:OCTETS-TO-STRING for a list of available encodings.

Package

netstrings

Source

netstrings.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Constants

Constant: +colon+
Package

netstrings

Source

netstrings.lisp (file)

Constant: +comma+
Package

netstrings

Source

netstrings.lisp (file)


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

6.2.2 Functions

Function: digitize BYTE

Converts a BYTE representing an ASCII decimal digit to that digit’s numeric value.

Package

netstrings

Source

netstrings.lisp (file)

Function: digitp BYTE

Checks whether BYTE represents a decimal digit in ASCII.

Package

netstrings

Source

netstrings.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-netstrings.asd: The cl-netstrings<dot>asd file
cl-netstrings/src: The cl-netstrings/src module
cl-netstrings/src/netstrings.lisp: The cl-netstrings/src/netstrings<dot>lisp file

F
File, Lisp, cl-netstrings.asd: The cl-netstrings<dot>asd file
File, Lisp, cl-netstrings/src/netstrings.lisp: The cl-netstrings/src/netstrings<dot>lisp file

L
Lisp File, cl-netstrings.asd: The cl-netstrings<dot>asd file
Lisp File, cl-netstrings/src/netstrings.lisp: The cl-netstrings/src/netstrings<dot>lisp file

M
Module, cl-netstrings/src: The cl-netstrings/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   D   F   R   W  
Index Entry  Section

D
digitize: Internal functions
digitp: Internal functions

F
Function, digitize: Internal functions
Function, digitp: Internal functions
Function, read-netstring: Exported functions
Function, write-netstring: Exported functions

R
read-netstring: Exported functions

W
write-netstring: Exported functions

Jump to:   D   F   R   W  

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

A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+colon+: Internal constants
+comma+: Internal constants

C
Constant, +colon+: Internal constants
Constant, +comma+: Internal constants

Jump to:   +  
C  

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

A.4 Data types

Jump to:   C   N   P   S  
Index Entry  Section

C
cl-netstrings: The cl-netstrings system

N
netstrings: The netstrings package
netstrings-asd: The netstrings-asd package

P
Package, netstrings: The netstrings package
Package, netstrings-asd: The netstrings-asd package

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

Jump to:   C   N   P   S