The cl-base64 Reference Manual

Table of Contents

The cl-base64 Reference Manual

This is the cl-base64 Reference Manual, version 3.4, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:31:52 2021 GMT+0.

1 Systems

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

1.1 cl-base64

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Kevin M. Rosenberg based on initial code by Juri Pakaste

License

BSD-style

Description

Base64 encoding and decoding with URI support.

Version

3.4

Source

cl-base64.asd (file)

Components

• package.lisp (file)
• encode.lisp (file)
• decode.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 cl-base64.asd

Location

cl-base64.asd

Systems

cl-base64 (system)

Packages

cl-base64-system

2.1.2 cl-base64/package.lisp

Parent

cl-base64 (system)

Location

package.lisp

Packages

cl-base64

Exported Definitions

• *uri-decode-table* (special variable)
• *uri-encode-table* (special variable)
• +decode-table+ (constant)
• +uri-decode-table+ (constant)
• make-decode-table (function)

Internal Definitions

• *decode-table* (special variable)
• *encode-table* (special variable)
• *pad-char* (special variable)
• *uri-pad-char* (special variable)
• decode-table (type)

2.1.3 cl-base64/encode.lisp

Dependency

package.lisp (file)

Parent

cl-base64 (system)

Location

encode.lisp

Exported Definitions

• integer-to-base64-stream (function)
• integer-to-base64-string (function)
• string-to-base64-stream (function)
• string-to-base64-string (function)
• usb8-array-to-base64-stream (function)
• usb8-array-to-base64-string (function)

Internal Definitions

• def-*-to-base64-* (macro)
• round-next-multiple (function)

2.1.4 cl-base64/decode.lisp

Dependency

package.lisp (file)

Parent

cl-base64 (system)

Location

decode.lisp

Exported Definitions

• bad-base64-character (condition)
• base64-error (condition)
• base64-stream-to-integer (function)
• base64-stream-to-stream (function)
• base64-stream-to-string (function)
• base64-stream-to-usb8-array (function)
• base64-string-to-integer (function)
• base64-string-to-stream (function)
• base64-string-to-string (function)
• base64-string-to-usb8-array (function)
• incomplete-base64-data (condition)

Internal Definitions

• array-index (type)
• array-length (type)
• bad-base64-character-code (method)
• base64-error-input (method)
• base64-error-position (method)
• character-code (type)
• define-base64-decoder (macro)
• etypecase/unroll (macro)
• let/typed (macro)

3 Packages

Packages are listed by definition order.

3.1 cl-base64-system

Source

cl-base64.asd

Use List

• common-lisp
• asdf/interface

3.2 cl-base64

Source

package.lisp (file)

Nickname

base64

Use List

common-lisp

Exported Definitions

• *uri-decode-table* (special variable)
• *uri-encode-table* (special variable)
• +decode-table+ (constant)
• +uri-decode-table+ (constant)
• bad-base64-character (condition)
• base64-error (condition)
• base64-stream-to-integer (function)
• base64-stream-to-stream (function)
• base64-stream-to-string (function)
• base64-stream-to-usb8-array (function)
• base64-string-to-integer (function)
• base64-string-to-stream (function)
• base64-string-to-string (function)
• base64-string-to-usb8-array (function)
• incomplete-base64-data (condition)
• integer-to-base64-stream (function)
• integer-to-base64-string (function)
• make-decode-table (function)
• string-to-base64-stream (function)
• string-to-base64-string (function)
• usb8-array-to-base64-stream (function)
• usb8-array-to-base64-string (function)

Internal Definitions

• *decode-table* (special variable)
• *encode-table* (special variable)
• *pad-char* (special variable)
• *uri-pad-char* (special variable)
• array-index (type)
• array-length (type)
• bad-base64-character-code (generic function)
• bad-base64-character-code (method)
• base64-error-input (generic function)
• base64-error-input (method)
• base64-error-position (generic function)
• base64-error-position (method)
• character-code (type)
• decode-table (type)
• def-*-to-base64-* (macro)
• define-base64-decoder (macro)
• etypecase/unroll (macro)
• let/typed (macro)
• round-next-multiple (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Constants

Constant: +decode-table+

Package

cl-base64

Source

package.lisp (file)

Constant: +uri-decode-table+

Package

cl-base64

Source

package.lisp (file)

4.1.2 Special variables

Special Variable: *uri-decode-table*

Deprecated.

Package

cl-base64

Source

package.lisp (file)

Special Variable: *uri-encode-table*

Package

cl-base64

Source

package.lisp (file)

4.1.3 Functions

Function: base64-stream-to-integer INPUT &key TABLE URI WHITESPACE

Decode Base64 stream to integer.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: base64-stream-to-stream INPUT &key TABLE URI STREAM WHITESPACE

Decode Base64 stream to stream.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: base64-stream-to-string INPUT &key TABLE URI WHITESPACE

Decode Base64 stream to string.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: base64-stream-to-usb8-array INPUT &key TABLE URI WHITESPACE

Decode Base64 stream to usb8-array.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: base64-string-to-integer INPUT &key TABLE URI WHITESPACE

Decode Base64 string to integer.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: base64-string-to-stream INPUT &key TABLE URI STREAM WHITESPACE

Decode Base64 string to stream.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: base64-string-to-string INPUT &key TABLE URI WHITESPACE

Decode Base64 string to string.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: base64-string-to-usb8-array INPUT &key TABLE URI WHITESPACE

Decode Base64 string to usb8-array.

TABLE is the decode table to use. Two decode tables are provided: +DECODE-TABLE+ (used by default) and +URI-DECODE-TABLE+. See MAKE-DECODE-TABLE.

For backwards-compatibility the URI parameter is supported. If it is true, then +URI-DECODE-TABLE+ is used, and the value for TABLE parameter is ignored.

WHITESPACE can be one of:

:ignore - Whitespace characters are ignored (default).
:signal - Signal a BAD-BASE64-CHARACTER condition using SIGNAL. :error - Signal a BAD-BASE64-CHARACTER condition using ERROR.

Package

cl-base64

Source

decode.lisp (file)

Function: integer-to-base64-stream INPUT STREAM &key URI COLUMNS

Encode an integer to base64 format.

Package

cl-base64

Source

encode.lisp (file)

Function: integer-to-base64-string INPUT &key URI COLUMNS

Encode an integer to base64 format.

Package

cl-base64

Source

encode.lisp (file)

Function: make-decode-table ENCODE-TABLE PAD-CHAR &key WHITESPACE-CHARS

Package

cl-base64

Source

package.lisp (file)

Function: string-to-base64-stream INPUT OUTPUT &key URI COLUMNS

Encode a string array to base64. If columns is > 0, designates maximum number of columns in a line and the string will be terminated with a #Newline.

Package

cl-base64

Source

encode.lisp (file)

Function: string-to-base64-string INPUT &key URI COLUMNS

Encode a string array to base64. If columns is > 0, designates maximum number of columns in a line and the string will be terminated with a #Newline.

Package

cl-base64

Source

encode.lisp (file)

Function: usb8-array-to-base64-stream INPUT OUTPUT &key URI COLUMNS

Encode a string array to base64. If columns is > 0, designates maximum number of columns in a line and the string will be terminated with a #Newline.

Package

cl-base64

Source

encode.lisp (file)

Function: usb8-array-to-base64-string INPUT &key URI COLUMNS

Encode a string array to base64. If columns is > 0, designates maximum number of columns in a line and the string will be terminated with a #Newline.

Package

cl-base64

Source

encode.lisp (file)

4.1.4 Conditions

Condition: bad-base64-character ()

Package

cl-base64

Source

decode.lisp (file)

Direct superclasses

base64-error (condition)

Direct methods

bad-base64-character-code (method)

Direct slots

Slot: code

Initargs

:code

Readers

bad-base64-character-code (generic function)

Condition: base64-error ()

Package

cl-base64

Source

decode.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• bad-base64-character (condition)
• incomplete-base64-data (condition)

Direct methods

• base64-error-position (method)
• base64-error-input (method)

Direct slots

Slot: input

Initargs

:input

Readers

base64-error-input (generic function)

Slot: position

Initargs

:position

Readers

base64-error-position (generic function)

Condition: incomplete-base64-data ()

Package

cl-base64

Source

decode.lisp (file)

Direct superclasses

base64-error (condition)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *decode-table*

Deprecated.

Package

cl-base64

Source

package.lisp (file)

Special Variable: *encode-table*

Package

cl-base64

Source

package.lisp (file)

Special Variable: *pad-char*

Package

cl-base64

Source

package.lisp (file)

Special Variable: *uri-pad-char*

Package

cl-base64

Source

package.lisp (file)

4.2.2 Macros

Macro: def-*-to-base64-* INPUT-TYPE OUTPUT-TYPE

Package

cl-base64

Source

encode.lisp (file)

Macro: define-base64-decoder HOSE SINK

Package

cl-base64

Source

decode.lisp (file)

Macro: etypecase/unroll (VAR &rest TYPES) &body BODY

Package

cl-base64

Source

decode.lisp (file)

Macro: let/typed (&rest VARS) &body BODY

Package

cl-base64

Source

decode.lisp (file)

4.2.3 Functions

Function: round-next-multiple X N

Round x up to the next highest multiple of n.

Package

cl-base64

Source

encode.lisp (file)

4.2.4 Generic functions

Generic Function: bad-base64-character-code CONDITION

Package

cl-base64

Methods

Method: bad-base64-character-code (CONDITION bad-base64-character)

Source

decode.lisp (file)

Generic Function: base64-error-input CONDITION

Package

cl-base64

Methods

Method: base64-error-input (CONDITION base64-error)

Source

decode.lisp (file)

Generic Function: base64-error-position CONDITION

Package

cl-base64

Methods

Method: base64-error-position (CONDITION base64-error)

Source

decode.lisp (file)

4.2.5 Types

Type: array-index &optional LENGTH

Package

cl-base64

Source

decode.lisp (file)

Type: array-length &optional LENGTH

Package

cl-base64

Source

decode.lisp (file)

Type: character-code ()

Package

cl-base64

Source

decode.lisp (file)

Type: decode-table ()

Package

cl-base64

Source

package.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types