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.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:08:16 2018 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.1

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


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

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)


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

Function: whitespace-p C

Returns T for a whitespace character.

Package

cl-base64

Source

decode.lisp (file)


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

4.2.4 Types

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<dot>asd file
cl-base64/decode.lisp: The cl-base64/decode<dot>lisp file
cl-base64/encode.lisp: The cl-base64/encode<dot>lisp file
cl-base64/package.lisp: The cl-base64/package<dot>lisp file

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

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

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   B   D   F   I   M   R   S   U   W  
Index Entry  Section

B
base64-stream-to-integer: 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
def-base64-string-to-*: Internal macros

F
Function, base64-stream-to-integer: 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
Function, whitespace-p: Internal functions

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

M
Macro, def-*-to-base64-*: Internal macros
Macro, def-base64-string-to-*: Internal macros
make-decode-table: Exported 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

W
whitespace-p: Internal functions

Jump to:   B   D   F   I   M   R   S   U   W  

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

A.3 Variables

Jump to:   *  
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

S
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:   *  
S  

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

A.4 Data types

Jump to:   C   D   P   S   T  
Index Entry  Section

C
cl-base64: The cl-base64 system
cl-base64: The cl-base64 package
cl-base64-system: The cl-base64-system package

D
decode-table: Internal types

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, decode-table: Internal types

Jump to:   C   D   P   S   T