The binary-parser Reference Manual

This is the binary-parser Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 04:23:37 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 binary-parser

A toolset for parsing binary data formats.

Author

Michael Fiano <>

Home Page

https://git.mfiano.net/mfiano/binary-parser

License

MIT

Dependencies
  • babel (system).
  • bitio (system).
  • chipz (system).
  • fast-io (system).
Source

binary-parser.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 binary-parser/binary-parser.asd

Source

binary-parser.asd.

Parent Component

binary-parser (system).

ASDF Systems

binary-parser.


3.1.2 binary-parser/package.lisp

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Packages

binary-parser.


3.1.3 binary-parser/buffer.lisp

Dependency

package.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface
Internals

3.1.4 binary-parser/common.lisp

Dependency

buffer.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface

split-string (function).

Internals

3.1.5 binary-parser/processors.lisp

Dependency

common.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface

3.1.6 binary-parser/readers.lisp

Dependency

processors.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 binary-parser

Source

package.lisp.

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 Special variables

Special Variable: *buffer*
Package

binary-parser.

Source

buffer.lisp.


5.1.2 Macros

Macro: with-buffer-read ((&key sequence stream) &body body)
Package

binary-parser.

Source

buffer.lisp.


5.1.3 Ordinary functions

Function: buffer-bits ()
Package

binary-parser.

Source

buffer.lisp.

Function: buffer-bytes ()
Package

binary-parser.

Source

buffer.lisp.

Function: buffer-position ()
Package

binary-parser.

Source

buffer.lisp.

Function: buffer-sequence ()
Package

binary-parser.

Source

buffer.lisp.

Function: buffer-stream ()
Package

binary-parser.

Source

buffer.lisp.

Function: octets= (octet-vector octet-list)
Package

binary-parser.

Source

readers.lisp.

Function: read-bits (count &key processor)
Package

binary-parser.

Source

readers.lisp.

Function: read-bytes (count &key bits-per-byte processor)
Package

binary-parser.

Source

readers.lisp.

Function: read-int-be (byte-count &key bits-per-byte processor)
Package

binary-parser.

Source

readers.lisp.

Function: read-int-le (byte-count &key bits-per-byte processor)
Package

binary-parser.

Source

readers.lisp.

Function: read-string (&key bytes encoding processor null-terminated-p)
Package

binary-parser.

Source

readers.lisp.

Function: read-uint-be (byte-count &key bits-per-byte processor)
Package

binary-parser.

Source

readers.lisp.

Function: read-uint-le (byte-count &key bits-per-byte processor)
Package

binary-parser.

Source

readers.lisp.

Function: split-string (string delimiter)
Package

binary-parser.

Source

common.lisp.

Function: uncompress-bzip2 (octet-vector)
Package

binary-parser.

Source

processors.lisp.

Function: uncompress-deflate (octet-vector)
Package

binary-parser.

Source

processors.lisp.

Function: uncompress-gzip (octet-vector)
Package

binary-parser.

Source

processors.lisp.

Function: uncompress-zlib (octet-vector)
Package

binary-parser.

Source

processors.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: %bitio-read-sequence (sequence buffer &key start end)
Package

binary-parser.

Source

buffer.lisp.

Function: %string-length (bytes null-terminated-p)
Package

binary-parser.

Source

common.lisp.

Function: %uncompress-octets (octet-vector compression-scheme)
Package

binary-parser.

Source

common.lisp.


5.2.2 Classes

Class: buffer
Package

binary-parser.

Source

buffer.lisp.

Direct slots
Slot: %bytes
Initargs

:bytes

Slot: %bits
Initargs

:bits

Slot: %sequence
Initargs

:sequence

Slot: %stream
Initargs

:stream


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
B   F   M   O   R   S   U   W  
Index Entry  Section

%
%bitio-read-sequence: Private ordinary functions
%string-length: Private ordinary functions
%uncompress-octets: Private ordinary functions

B
buffer-bits: Public ordinary functions
buffer-bytes: Public ordinary functions
buffer-position: Public ordinary functions
buffer-sequence: Public ordinary functions
buffer-stream: Public ordinary functions

F
Function, %bitio-read-sequence: Private ordinary functions
Function, %string-length: Private ordinary functions
Function, %uncompress-octets: Private ordinary functions
Function, buffer-bits: Public ordinary functions
Function, buffer-bytes: Public ordinary functions
Function, buffer-position: Public ordinary functions
Function, buffer-sequence: Public ordinary functions
Function, buffer-stream: Public ordinary functions
Function, octets=: Public ordinary functions
Function, read-bits: Public ordinary functions
Function, read-bytes: Public ordinary functions
Function, read-int-be: Public ordinary functions
Function, read-int-le: Public ordinary functions
Function, read-string: Public ordinary functions
Function, read-uint-be: Public ordinary functions
Function, read-uint-le: Public ordinary functions
Function, split-string: Public ordinary functions
Function, uncompress-bzip2: Public ordinary functions
Function, uncompress-deflate: Public ordinary functions
Function, uncompress-gzip: Public ordinary functions
Function, uncompress-zlib: Public ordinary functions

M
Macro, with-buffer-read: Public macros

O
octets=: Public ordinary functions

R
read-bits: Public ordinary functions
read-bytes: Public ordinary functions
read-int-be: Public ordinary functions
read-int-le: Public ordinary functions
read-string: Public ordinary functions
read-uint-be: Public ordinary functions
read-uint-le: Public ordinary functions

S
split-string: Public ordinary functions

U
uncompress-bzip2: Public ordinary functions
uncompress-deflate: Public ordinary functions
uncompress-gzip: Public ordinary functions
uncompress-zlib: Public ordinary functions

W
with-buffer-read: Public macros