The cl-base64 Reference Manual

Table of Contents

The cl-base64 Reference Manual

This is the cl-base64 Reference Manual, version 3.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 10:47:01 2020 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.1

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)
• 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

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

Internal Definitions

• def-base64-string-to-* (macro)
• whitespace-p (function)

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)
• base64-stream-to-integer (function)
• base64-string-to-integer (function)
• base64-string-to-stream (function)
• base64-string-to-string (function)
• base64-string-to-usb8-array (function)
• 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)
• decode-table (type)
• def-*-to-base64-* (macro)
• def-base64-string-to-* (macro)
• round-next-multiple (function)
• whitespace-p (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *uri-decode-table*

Package

cl-base64

Source

package.lisp (file)

Special Variable: *uri-encode-table*

Package

cl-base64

Source

package.lisp (file)

4.1.2 Functions

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

Decodes a base64 string to an integer

Package

cl-base64

Source

decode.lisp (file)

Function: base64-string-to-integer STRING &key URI

Decodes a base64 string to an integer

Package

cl-base64

Source

decode.lisp (file)

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

Decode base64 string to stream

Package

cl-base64

Source

decode.lisp (file)

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

Decode base64 string to string

Package

cl-base64

Source

decode.lisp (file)

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

Decode base64 string to usb8-array

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

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.2 Internal definitions

4.2.1 Special variables

Special Variable: *decode-table*

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: def-base64-string-to-* OUTPUT-TYPE

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)

Function: whitespace-p C

Returns T for a whitespace character.

Package

cl-base64

Source

decode.lisp (file)

4.2.4 Types

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