The cl-base64 Reference Manual

Table of Contents

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

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.


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

1 Systems

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


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

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

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

2 Files

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


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

2.1 Lisp


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

2.1.1 cl-base64.asd

Location

cl-base64.asd

Systems

cl-base64 (system)

Packages

cl-base64-system


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

2.1.2 cl-base64/package.lisp

Parent

cl-base64 (system)

Location

package.lisp

Packages

cl-base64

Exported Definitions
Internal Definitions

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

2.1.3 cl-base64/encode.lisp

Dependency

package.lisp (file)

Parent

cl-base64 (system)

Location

encode.lisp

Exported Definitions
Internal Definitions

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

2.1.4 cl-base64/decode.lisp

Dependency

package.lisp (file)

Parent

cl-base64 (system)

Location

decode.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 cl-base64-system

Source

cl-base64.asd

Use List

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

3.2 cl-base64

Source

package.lisp (file)

Nickname

base64

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

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)


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

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)


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

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)


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

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
Direct methods
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)


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

4.2 Internal definitions


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

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)


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

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)


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

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)


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

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)


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

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-base64.asd: The cl-base64․asd file
cl-base64/decode.lisp: The cl-base64/decode․lisp file
cl-base64/encode.lisp: The cl-base64/encode․lisp file
cl-base64/package.lisp: The cl-base64/package․lisp file

F
File, Lisp, cl-base64.asd: The cl-base64․asd file
File, Lisp, cl-base64/decode.lisp: The cl-base64/decode․lisp file
File, Lisp, cl-base64/encode.lisp: The cl-base64/encode․lisp file
File, Lisp, cl-base64/package.lisp: The cl-base64/package․lisp file

L
Lisp File, cl-base64.asd: The cl-base64․asd file
Lisp File, cl-base64/decode.lisp: The cl-base64/decode․lisp file
Lisp File, cl-base64/encode.lisp: The cl-base64/encode․lisp file
Lisp File, cl-base64/package.lisp: The cl-base64/package․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   B   D   E   F   G   I   L   M   R   S   U  
Index Entry  Section

B
bad-base64-character-code: Internal generic functions
bad-base64-character-code: Internal generic functions
base64-error-input: Internal generic functions
base64-error-input: Internal generic functions
base64-error-position: Internal generic functions
base64-error-position: Internal generic functions
base64-stream-to-integer: Exported functions
base64-stream-to-stream: Exported functions
base64-stream-to-string: Exported functions
base64-stream-to-usb8-array: Exported functions
base64-string-to-integer: Exported functions
base64-string-to-stream: Exported functions
base64-string-to-string: Exported functions
base64-string-to-usb8-array: Exported functions

D
def-*-to-base64-*: Internal macros
define-base64-decoder: Internal macros

E
etypecase/unroll: Internal macros

F
Function, base64-stream-to-integer: Exported functions
Function, base64-stream-to-stream: Exported functions
Function, base64-stream-to-string: Exported functions
Function, base64-stream-to-usb8-array: Exported functions
Function, base64-string-to-integer: Exported functions
Function, base64-string-to-stream: Exported functions
Function, base64-string-to-string: Exported functions
Function, base64-string-to-usb8-array: Exported functions
Function, integer-to-base64-stream: Exported functions
Function, integer-to-base64-string: Exported functions
Function, make-decode-table: Exported functions
Function, round-next-multiple: Internal functions
Function, string-to-base64-stream: Exported functions
Function, string-to-base64-string: Exported functions
Function, usb8-array-to-base64-stream: Exported functions
Function, usb8-array-to-base64-string: Exported functions

G
Generic Function, bad-base64-character-code: Internal generic functions
Generic Function, base64-error-input: Internal generic functions
Generic Function, base64-error-position: Internal generic functions

I
integer-to-base64-stream: Exported functions
integer-to-base64-string: Exported functions

L
let/typed: Internal macros

M
Macro, def-*-to-base64-*: Internal macros
Macro, define-base64-decoder: Internal macros
Macro, etypecase/unroll: Internal macros
Macro, let/typed: Internal macros
make-decode-table: Exported functions
Method, bad-base64-character-code: Internal generic functions
Method, base64-error-input: Internal generic functions
Method, base64-error-position: Internal generic functions

R
round-next-multiple: Internal functions

S
string-to-base64-stream: Exported functions
string-to-base64-string: Exported functions

U
usb8-array-to-base64-stream: Exported functions
usb8-array-to-base64-string: Exported functions

Jump to:   B   D   E   F   G   I   L   M   R   S   U  

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

A.3 Variables

Jump to:   *   +  
C   I   P   S  
Index Entry  Section

*
*decode-table*: Internal special variables
*encode-table*: Internal special variables
*pad-char*: Internal special variables
*uri-decode-table*: Exported special variables
*uri-encode-table*: Exported special variables
*uri-pad-char*: Internal special variables

+
+decode-table+: Exported constants
+uri-decode-table+: Exported constants

C
code: Exported conditions
Constant, +decode-table+: Exported constants
Constant, +uri-decode-table+: Exported constants

I
input: Exported conditions

P
position: Exported conditions

S
Slot, code: Exported conditions
Slot, input: Exported conditions
Slot, position: Exported conditions
Special Variable, *decode-table*: Internal special variables
Special Variable, *encode-table*: Internal special variables
Special Variable, *pad-char*: Internal special variables
Special Variable, *uri-decode-table*: Exported special variables
Special Variable, *uri-encode-table*: Exported special variables
Special Variable, *uri-pad-char*: Internal special variables

Jump to:   *   +  
C   I   P   S  

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

A.4 Data types

Jump to:   A   B   C   D   I   P   S   T  
Index Entry  Section

A
array-index: Internal types
array-length: Internal types

B
bad-base64-character: Exported conditions
base64-error: Exported conditions

C
character-code: Internal types
cl-base64: The cl-base64 system
cl-base64: The cl-base64 package
cl-base64-system: The cl-base64-system package
Condition, bad-base64-character: Exported conditions
Condition, base64-error: Exported conditions
Condition, incomplete-base64-data: Exported conditions

D
decode-table: Internal types

I
incomplete-base64-data: Exported conditions

P
Package, cl-base64: The cl-base64 package
Package, cl-base64-system: The cl-base64-system package

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

T
Type, array-index: Internal types
Type, array-length: Internal types
Type, character-code: Internal types
Type, decode-table: Internal types

Jump to:   A   B   C   D   I   P   S   T