The cl-netstrings Reference Manual

This is the cl-netstrings Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 05:06:32 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-netstrings

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

Maintainer

Daniel Janus

Author

Daniel Janus

License

MIT

Version

0.1

Dependencies
  • iterate (system).
  • arnesi (system).
Source

cl-netstrings.asd.

Child Component

src (module).


3 Modules

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


3.1 cl-netstrings/src

Source

cl-netstrings.asd.

Parent Component

cl-netstrings (system).

Child Component

netstrings.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 cl-netstrings/cl-netstrings.asd

Source

cl-netstrings.asd.

Parent Component

cl-netstrings (system).

ASDF Systems

cl-netstrings.

Packages

netstrings-asd.


4.1.2 cl-netstrings/src/netstrings.lisp

Source

cl-netstrings.asd.

Parent Component

src (module).

Packages

netstrings.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 netstrings-asd

Source

cl-netstrings.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.2 netstrings

Source

netstrings.lisp.

Nickname

cl-netstrings

Use List
  • common-lisp.
  • it.bese.arnesi.
  • iterate.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary 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.

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.


6.2 Internals


6.2.1 Constants

Constant: +colon+
Package

netstrings.

Source

netstrings.lisp.

Constant: +comma+
Package

netstrings.

Source

netstrings.lisp.


6.2.2 Ordinary functions

Function: digitize (byte)

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

Package

netstrings.

Source

netstrings.lisp.

Function: digitp (byte)

Checks whether BYTE represents a decimal digit in ASCII.

Package

netstrings.

Source

netstrings.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   +  
C  
Index Entry  Section

+
+colon+: Private constants
+comma+: Private constants

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