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

The s-base64 Reference Manual

This is the s-base64 Reference Manual, version 2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:49:27 2024 GMT+0.

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

1 Introduction

Next: Modules, Previous: Introduction, Up: The s-base64 Reference Manual [Contents][Index]

2 Systems

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

s-base64

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

2.1 `s-base64`

Common Lisp Base64 Package

Maintainer: Sven Van Caekenberghe <svc@mac.com>
Author: Sven Van Caekenberghe <svc@mac.com>
License: Lesser Lisp General Public License (LLGPL)
Long Description: S-BASE64 is a Common Lisp implementation of Base64 Encoding/Decoding
Version: 2
Source: s-base64.asd.
Child Component: src (module).

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

3 Modules

Modules are listed depth-first from the system components tree.

s-base64/src

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

3.1 `s-base64/src`

Source

s-base64.asd.

Parent Component

s-base64 (system).

Child Components

package.lisp (file).
base64.lisp (file).

Next: Packages, Previous: Modules, Up: The s-base64 Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: s-base64/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `s-base64/s-base64.asd`

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

Next: s-base64/src/base64.lisp, Previous: s-base64/s-base64.asd, Up: Lisp [Contents][Index]

4.1.2 `s-base64/src/package.lisp`

Source: s-base64.asd.
Parent Component: src (module).
Packages: s-base64.

Previous: s-base64/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `s-base64/src/base64.lisp`

Dependency

package.lisp (file).

Source

s-base64.asd.

Parent Component

src (module).

Public Interface

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

Internals

+base64-alphabet+ (special variable).
+inverse-base64-alphabet+ (special variable).
core-decode-base64 (function).
core-encode-base64 (function).
skip-base64-whitespace (function).

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

5 Packages

Packages are listed by definition order.

s-base64

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

5.1 `s-base64`

An implementation of standard Base64 encoding and decoding

Source

package.lisp.

Use List

common-lisp.

Public Interface

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

Internals

+base64-alphabet+ (special variable).
+inverse-base64-alphabet+ (special variable).
core-decode-base64 (function).
core-encode-base64 (function).
skip-base64-whitespace (function).

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

6 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]

6.1 Public Interface

Ordinary functions

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

6.1.1 Ordinary functions

Function: decode-base64 (in out) ¶

Decode a base64 encoded character input stream into a binary output stream

Package: s-base64.
Source: base64.lisp.

Function: decode-base64-bytes (stream) ¶

Decode a base64 encoded character stream, returns a byte array

Package: s-base64.
Source: base64.lisp.

Function: encode-base64 (in out &optional break-lines) ¶

Encode a binary input stream into a base64 encoded character output stream

Package: s-base64.
Source: base64.lisp.

Function: encode-base64-bytes (array stream &optional break-lines) ¶

Encode a byte array into a base64 encoded character stream

Package: s-base64.
Source: base64.lisp.

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

6.2 Internals

Special variables
Ordinary functions

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

6.2.1 Special variables

Special Variable: +base64-alphabet+ ¶

Package: s-base64.
Source: base64.lisp.

Special Variable: +inverse-base64-alphabet+ ¶

Package: s-base64.
Source: base64.lisp.

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

6.2.2 Ordinary functions

Function: core-decode-base64 (char1 char2 char3 char4) ¶

Package: s-base64.
Source: base64.lisp.

Function: core-encode-base64 (byte1 byte2 byte3) ¶

Package: s-base64.
Source: base64.lisp.

Function: skip-base64-whitespace (stream) ¶

Package: s-base64.
Source: base64.lisp.

Previous: Definitions, Up: The s-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:	C D E F S

	Index Entry	Section

C
	`core-decode-base64`:	Private ordinary functions
	`core-encode-base64`:	Private ordinary functions

D
	`decode-base64`:	Public ordinary functions
	`decode-base64-bytes`:	Public ordinary functions

E
	`encode-base64`:	Public ordinary functions
	`encode-base64-bytes`:	Public ordinary functions

F
	`Function, core-decode-base64`:	Private ordinary functions
	`Function, core-encode-base64`:	Private ordinary functions
	`Function, decode-base64`:	Public ordinary functions
	`Function, decode-base64-bytes`:	Public ordinary functions
	`Function, encode-base64`:	Public ordinary functions
	`Function, encode-base64-bytes`:	Public ordinary functions
	`Function, skip-base64-whitespace`:	Private ordinary functions

S
	`skip-base64-whitespace`:	Private ordinary functions

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

A.3 Variables

Jump to:	+ S

	Index Entry	Section

+
	`+base64-alphabet+`:	Private special variables
	`+inverse-base64-alphabet+`:	Private special variables

S
	`Special Variable, +base64-alphabet+`:	Private special variables
	`Special Variable, +inverse-base64-alphabet+`:	Private special variables

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

A.4 Data types

Jump to:	B F M P S

	Index Entry	Section

B
	`base64.lisp`:	The s-base64/src/base64․lisp file

F
	`File, base64.lisp`:	The s-base64/src/base64․lisp file
	`File, package.lisp`:	The s-base64/src/package․lisp file
	`File, s-base64.asd`:	The s-base64/s-base64․asd file

M
	`Module, src`:	The s-base64/src module

P
	`Package, s-base64`:	The s-base64 package
	`package.lisp`:	The s-base64/src/package․lisp file

S
	`s-base64`:	The s-base64 system
	`s-base64`:	The s-base64 package
	`s-base64.asd`:	The s-base64/s-base64․asd file
	`src`:	The s-base64/src module
	`System, s-base64`:	The s-base64 system

The s-base64 Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 s-base64

3 Modules

3.1 s-base64/src

4 Files

4.1 Lisp

4.1.1 s-base64/s-base64.asd

4.1.2 s-base64/src/package.lisp

4.1.3 s-base64/src/base64.lisp

5 Packages

5.1 s-base64

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `s-base64`

3.1 `s-base64/src`

4.1.1 `s-base64/s-base64.asd`

4.1.2 `s-base64/src/package.lisp`

4.1.3 `s-base64/src/base64.lisp`

5.1 `s-base64`