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

The base64 Reference Manual

This is the base64 Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:40:28 2024 GMT+0.

Next: Systems, Previous: The base64 Reference Manual, Up: The base64 Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The base64 Reference Manual [Contents][Index]

2 Systems

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

base64

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

2.1 `base64`

Base64 encoding and decoding for Common Lisp.

Author: Jeffrey Massung
License: Apache 2.0
Version: 1.0
Source: base64.asd.
Child Component: base64.lisp (file).

Next: Packages, Previous: Systems, Up: The base64 Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: base64/base64.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `base64/base64.asd`

Source: base64.asd.
Parent Component: base64 (system).
ASDF Systems: base64.
Packages: base64-asd.

Previous: base64/base64.asd, Up: Lisp [Contents][Index]

3.1.2 `base64/base64.lisp`

Source

base64.asd.

Parent Component

base64 (system).

Packages

base64.

Public Interface

base64-decode (function).
base64-encode (function).

Internals

*base64* (special variable).
decode-octet (function).
encode-octet (function).
make-octet (function).
make-quartet (function).

Next: Definitions, Previous: Files, Up: The base64 Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

base64
base64-asd

Next: base64-asd, Previous: Packages, Up: Packages [Contents][Index]

4.1 `base64`

Source

base64.lisp.

Use List

common-lisp.

Public Interface

base64-decode (function).
base64-encode (function).

Internals

*base64* (special variable).
decode-octet (function).
encode-octet (function).
make-octet (function).
make-quartet (function).

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

4.2 `base64-asd`

Source

base64.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The base64 Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: base64-decode (string) ¶

Decode a string into a simple string.

Package: base64.
Source: base64.lisp.

Function: base64-encode (string) ¶

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

Package: base64.
Source: base64.lisp.

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *base64* ¶

Package: base64.
Source: base64.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: decode-octet (out b1 b2 b3 b4) ¶

Writes the next three characters to the output stream.

Package: base64.
Source: base64.lisp.

Function: encode-octet (out b1 &optional b2 b3) ¶

Writes the next four characters to the output stream.

Package: base64.
Source: base64.lisp.

Function: make-octet (b1 &optional b2 b3) ¶

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

Package: base64.
Source: base64.lisp.

Function: make-quartet (b1 b2 b3 b4) ¶

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

Package: base64.
Source: base64.lisp.

Previous: Definitions, Up: The base64 Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	B D E F M

	Index Entry	Section

B
	`base64-decode`:	Public ordinary functions
	`base64-encode`:	Public ordinary functions

D
	`decode-octet`:	Private ordinary functions

E
	`encode-octet`:	Private ordinary functions

F
	`Function, base64-decode`:	Public ordinary functions
	`Function, base64-encode`:	Public ordinary functions
	`Function, decode-octet`:	Private ordinary functions
	`Function, encode-octet`:	Private ordinary functions
	`Function, make-octet`:	Private ordinary functions
	`Function, make-quartet`:	Private ordinary functions

M
	`make-octet`:	Private ordinary functions
	`make-quartet`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`base64`:	Private special variables

S
	`Special Variable, base64`:	Private special variables

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

A.4 Data types

Jump to:	B F P S

	Index Entry	Section

B
	`base64`:	The base64 system
	`base64`:	The base64 package
	`base64-asd`:	The base64-asd package
	`base64.asd`:	The base64/base64․asd file
	`base64.lisp`:	The base64/base64․lisp file

F
	`File, base64.asd`:	The base64/base64․asd file
	`File, base64.lisp`:	The base64/base64․lisp file

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

S
	`System, base64`:	The base64 system

The base64 Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 base64

3 Files

3.1 Lisp

3.1.1 base64/base64.asd

3.1.2 base64/base64.lisp

4 Packages

4.1 base64

4.2 base64-asd

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `base64`

3.1.1 `base64/base64.asd`

3.1.2 `base64/base64.lisp`

4.1 `base64`

4.2 `base64-asd`