The base64 Reference Manual

Table of Contents

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

The base64 Reference Manual

This is the base64 Reference Manual, version 1.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 12:57:55 2019 GMT+0.


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

1 Introduction

Base64 Encode/Decode for Common Lisp

A very simple implementation of Base64 encoding and decoding for Common Lisp.

Quickstart

Just use the base64-encode and base64-decode functions to encode and decode from and to strings.

CL-USER > (base64-encode "Man is distinguished")
"TWFuIGlzIGRpc3Rpbmd1aXNoZWQ="

CL-USER > (base64-decode *)
"Man is distinguished"

That's pretty much it. ;-)

In the future, I'll add base64-encode-binary and base64-decode-binary. But right now I have no need for them. If you create these, please send me a pull request!


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

2 Systems

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


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

2.1 base64

Author

Jeffrey Massung

License

Apache 2.0

Description

Base64 encoding and decoding for Common Lisp.

Version

1.0

Source

base64.asd (file)

Component

base64.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 base64.asd

Location

base64.asd

Systems

base64 (system)

Packages

base64-asd


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

3.1.2 base64/base64.lisp

Parent

base64 (system)

Location

base64.lisp

Packages

base64

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 base64-asd

Source

base64.asd

Use List

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

4.2 base64

Source

base64.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: base64-decode STRING

Decode a string into a simple string.

Package

base64

Source

base64.lisp (file)

Function: base64-encode STRING

Encode a simple string of base-chars into a base64 string.

Package

base64

Source

base64.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *base64*
Package

base64

Source

base64.lisp (file)


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

5.2.2 Functions

Function: decode-octet OUT B1 B2 B3 B4 &aux P

Writes the next three characters to the output stream.

Package

base64

Source

base64.lisp (file)

Function: encode-octet OUT B1 &optional B2 B3 &aux P

Writes the next four characters to the output stream.

Package

base64

Source

base64.lisp (file)

Function: make-octet B1 &optional B2 B3

Create a 3-byte octet from 1, 2, or 3 characters.

Package

base64

Source

base64.lisp (file)

Function: make-quartet B1 B2 B3 B4

Create a 3-byte quartet from 2, 3, or 4 encoded characters.

Package

base64

Source

base64.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   B   F   L  
Index Entry  Section

B
base64.asd: The base64<dot>asd file
base64/base64.lisp: The base64/base64<dot>lisp file

F
File, Lisp, base64.asd: The base64<dot>asd file
File, Lisp, base64/base64.lisp: The base64/base64<dot>lisp file

L
Lisp File, base64.asd: The base64<dot>asd file
Lisp File, base64/base64.lisp: The base64/base64<dot>lisp file

Jump to:   B   F   L  

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

A.2 Functions

Jump to:   B   D   E   F   M  
Index Entry  Section

B
base64-decode: Exported functions
base64-encode: Exported functions

D
decode-octet: Internal functions

E
encode-octet: Internal functions

F
Function, base64-decode: Exported functions
Function, base64-encode: Exported functions
Function, decode-octet: Internal functions
Function, encode-octet: Internal functions
Function, make-octet: Internal functions
Function, make-quartet: Internal functions

M
make-octet: Internal functions
make-quartet: Internal functions

Jump to:   B   D   E   F   M  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*base64*: Internal special variables

S
Special Variable, *base64*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   B   P   S  
Index Entry  Section

B
base64: The base64 system
base64: The base64 package
base64-asd: The base64-asd package

P
Package, base64: The base64 package
Package, base64-asd: The base64-asd package

S
System, base64: The base64 system

Jump to:   B   P   S