The s-base64 Reference Manual

This is the s-base64 Reference Manual, version 2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:12:24 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 s-base64

Common Lisp Base64 Package

Maintainer

Sven Van Caekenberghe <>

Author

Sven Van Caekenberghe <>

License

Lesser Lisp General Public License (LLGPL)

Long Description

S-BASE64 is a Common Lisp implementation of Base64 Encoding/Decoding

Version

2

Source

s-base64.asd.

Child Component

src (module).


3 Modules

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


3.1 s-base64/src

Source

s-base64.asd.

Parent Component

s-base64 (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 s-base64/s-base64.asd

Source

s-base64.asd.

Parent Component

s-base64 (system).

ASDF Systems

s-base64.


4.1.2 s-base64/src/package.lisp

Source

s-base64.asd.

Parent Component

src (module).

Packages

s-base64.


4.1.3 s-base64/src/base64.lisp

Dependency

package.lisp (file).

Source

s-base64.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 s-base64

An implementation of standard Base64 encoding and decoding

Source

package.lisp.

Use List

common-lisp.

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: decode-base64 (in out)

Decode a base64 encoded character input stream into a binary output stream

Package

s-base64.

Source

base64.lisp.

Function: decode-base64-bytes (stream)

Decode a base64 encoded character stream, returns a byte array

Package

s-base64.

Source

base64.lisp.

Function: encode-base64 (in out &optional break-lines)

Encode a binary input stream into a base64 encoded character output stream

Package

s-base64.

Source

base64.lisp.

Function: encode-base64-bytes (array stream &optional break-lines)

Encode a byte array into a base64 encoded character stream

Package

s-base64.

Source

base64.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: +base64-alphabet+
Package

s-base64.

Source

base64.lisp.

Special Variable: +inverse-base64-alphabet+
Package

s-base64.

Source

base64.lisp.


6.2.2 Ordinary functions

Function: core-decode-base64 (char1 char2 char3 char4)
Package

s-base64.

Source

base64.lisp.

Function: core-encode-base64 (byte1 byte2 byte3)
Package

s-base64.

Source

base64.lisp.

Function: skip-base64-whitespace (stream)
Package

s-base64.

Source

base64.lisp.


Appendix A Indexes


A.1 Concepts