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

The cl-base32 Reference Manual

This is the cl-base32 Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 03:42:09 2023 GMT+0.

Next: Systems, Previous: The cl-base32 Reference Manual, Up: The cl-base32 Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-base32 Reference Manual [Contents][Index]

2 Systems

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

cl-base32

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

2.1 `cl-base32`

Version

0.1

Source

cl-base32.asd.

Child Components

package.lisp (file).
base32.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-base32 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: cl-base32/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-base32/cl-base32.asd`

Source: cl-base32.asd.
Parent Component: cl-base32 (system).
ASDF Systems: cl-base32.

Next: cl-base32/base32.lisp, Previous: cl-base32/cl-base32.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-base32/package.lisp`

Source

cl-base32.asd.

Parent Component

cl-base32 (system).

Packages

cl-base32.
cl-base32-asd.

Previous: cl-base32/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-base32/base32.lisp`

Dependency

package.lisp (file).

Source

cl-base32.asd.

Parent Component

cl-base32 (system).

Public Interface

base32-to-bytes (function).
bytes-to-base32 (function).

Internals

*base32-alphabet* (special variable).
base32-length-from-bytes (function).
byte-length-from-base32 (function).
decode-word (function).
encode-word (function).
read-word (function).
unpadded-base32-length (function).
write-word (function).

Next: Definitions, Previous: Files, Up: The cl-base32 Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-base32
cl-base32-asd

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

4.1 `cl-base32`

This package implements the base32 encoding/decoding defined in RF 4648.

Source

package.lisp.

Nickname

base32

Use List

common-lisp.

Public Interface

base32-to-bytes (function).
bytes-to-base32 (function).

Internals

*base32-alphabet* (special variable).
base32-length-from-bytes (function).
byte-length-from-base32 (function).
decode-word (function).
encode-word (function).
read-word (function).
unpadded-base32-length (function).
write-word (function).

Previous: cl-base32, Up: Packages [Contents][Index]

4.2 `cl-base32-asd`

Source

package.lisp.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The cl-base32 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: base32-to-bytes (base32-string) ¶

Return the bytes decoded from the supplied base32 string

Package: cl-base32.
Source: base32.lisp.

Function: bytes-to-base32 (some-bytes) ¶

Return a base32 string encoding of the provided vector of bytes

Package: cl-base32.
Source: base32.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: *base32-alphabet* ¶

Package: cl-base32.
Source: base32.lisp.

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

5.2.2 Ordinary functions

Function: base32-length-from-bytes (some-bytes) ¶

Given bytes of unencoded data, determine the length of the corresponding base32-encoded string

Package: cl-base32.
Source: base32.lisp.

Function: byte-length-from-base32 (base32-string) ¶

Given a base32 string, compute the number of bytes in the decoded data

Package: cl-base32.
Source: base32.lisp.

Function: decode-word (a-digit) ¶

Return the word encoded as a digit in the base32 alphabet

Package: cl-base32.
Source: base32.lisp.

Function: encode-word (a-word) ¶

Return the digit in the base32 alphabet corresponding to a word

Package: cl-base32.
Source: base32.lisp.

Function: read-word (some-bytes word-index) ¶

Return the word (a 5-bit integer) found in some-bytes located at word-index

Package: cl-base32.
Source: base32.lisp.

Function: unpadded-base32-length (base32-string) ¶

Given a base32 string, compute the size of the raw base32 string, without any = padding

Package: cl-base32.
Source: base32.lisp.

Function: write-word (some-bytes word-index word) ¶

Write the word into the bits located at word-index in some-bytes

Package: cl-base32.
Source: base32.lisp.

Previous: Definitions, Up: The cl-base32 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 R U W

	Index Entry	Section

B
	`base32-length-from-bytes`:	Private ordinary functions
	`base32-to-bytes`:	Public ordinary functions
	`byte-length-from-base32`:	Private ordinary functions
	`bytes-to-base32`:	Public ordinary functions

D
	`decode-word`:	Private ordinary functions

E
	`encode-word`:	Private ordinary functions

F
	`Function, base32-length-from-bytes`:	Private ordinary functions
	`Function, base32-to-bytes`:	Public ordinary functions
	`Function, byte-length-from-base32`:	Private ordinary functions
	`Function, bytes-to-base32`:	Public ordinary functions
	`Function, decode-word`:	Private ordinary functions
	`Function, encode-word`:	Private ordinary functions
	`Function, read-word`:	Private ordinary functions
	`Function, unpadded-base32-length`:	Private ordinary functions
	`Function, write-word`:	Private ordinary functions

R
	`read-word`:	Private ordinary functions

U
	`unpadded-base32-length`:	Private ordinary functions

W
	`write-word`:	Private ordinary functions

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

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`base32-alphabet`:	Private special variables

S
	`Special Variable, base32-alphabet`:	Private special variables

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

A.4 Data types

Jump to:	B C F P S

	Index Entry	Section

B
	`base32.lisp`:	The cl-base32/base32․lisp file

C
	`cl-base32`:	The cl-base32 system
	`cl-base32`:	The cl-base32 package
	`cl-base32-asd`:	The cl-base32-asd package
	`cl-base32.asd`:	The cl-base32/cl-base32․asd file

F
	`File, base32.lisp`:	The cl-base32/base32․lisp file
	`File, cl-base32.asd`:	The cl-base32/cl-base32․asd file
	`File, package.lisp`:	The cl-base32/package․lisp file

P
	`Package, cl-base32`:	The cl-base32 package
	`Package, cl-base32-asd`:	The cl-base32-asd package
	`package.lisp`:	The cl-base32/package․lisp file

S
	`System, cl-base32`:	The cl-base32 system

The cl-base32 Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-base32

3 Files

3.1 Lisp

3.1.1 cl-base32/cl-base32.asd

3.1.2 cl-base32/package.lisp

3.1.3 cl-base32/base32.lisp

4 Packages

4.1 cl-base32

4.2 cl-base32-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 `cl-base32`

3.1.1 `cl-base32/cl-base32.asd`

3.1.2 `cl-base32/package.lisp`

3.1.3 `cl-base32/base32.lisp`

4.1 `cl-base32`

4.2 `cl-base32-asd`