The cl-base32 Reference Manual

Table of Contents

The cl-base32 Reference Manual

This is the cl-base32 Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:06:49 2020 GMT+0.

1 Introduction

CL-Base32 is a Common Lisp library for encoding / decoding bytes to / from base32 strings
(e.g., RFC 4648).

One advantage of base32 encoding is that the resulting strings do not require URL encoding
for use in an URL, as the base32 alphabet contains no characters that must be encoded
to appear in an URL.

This package is intended to be portable across as many Common Lisp implementations
and platforms as possible.  Any issues with such portability should be reported
phil@haphazardhouse.net.

Known to work on CCL & SBCL for Mac OS X.

Current source can be found here: http://github.com/hargettp/cl-base32. 

Home page is here: http://haphazardhouse.net/projects/cl-base32.

2 Systems

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

2.1 cl-base32

Version

0.1

Source

cl-base32.asd (file)

Components

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

3 Files

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

3.1 Lisp

3.1.1 cl-base32.asd

Location

cl-base32.asd

Systems

cl-base32 (system)

3.1.2 cl-base32/package.lisp

Parent

cl-base32 (system)

Location

package.lisp

Packages

• cl-base32-asd
• cl-base32

3.1.3 cl-base32/base32.lisp

Dependency

package.lisp (file)

Parent

cl-base32 (system)

Location

base32.lisp

Exported Definitions

• base32-to-bytes (function)
• bytes-to-base32 (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 cl-base32-asd

Source

package.lisp (file)

Use List

• asdf/interface
• common-lisp

4.2 cl-base32

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

Source

package.lisp (file)

Nickname

base32

Use List

common-lisp

Exported Definitions

• base32-to-bytes (function)
• bytes-to-base32 (function)

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: base32-to-bytes BASE32-STRING

Return the bytes decoded from the supplied base32 string

Package

cl-base32

Source

base32.lisp (file)

Function: bytes-to-base32 SOME-BYTES

Return a base32 string encoding of the provided vector of bytes

Package

cl-base32

Source

base32.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *base32-alphabet*

Package

cl-base32

Source

base32.lisp (file)

5.2.2 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 (file)

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

Function: decode-word A-DIGIT

Return the word encoded as a digit in the base32 alphabet

Package

cl-base32

Source

base32.lisp (file)

Function: encode-word A-WORD

Return the digit in the base32 alphabet corresponding to a word

Package

cl-base32

Source

base32.lisp (file)

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

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

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

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types