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 Sat Dec 03 19:52:25 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-base32

Version

0.1

Source

cl-base32.asd.

Child Components

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/cl-base32.asd

Source

cl-base32.asd.

Parent Component

cl-base32 (system).

ASDF Systems

cl-base32.


3.1.2 cl-base32/package.lisp

Source

cl-base32.asd.

Parent Component

cl-base32 (system).

Packages

3.1.3 cl-base32/base32.lisp

Dependency

package.lisp (file).

Source

cl-base32.asd.

Parent Component

cl-base32 (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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
Internals

4.2 cl-base32-asd

Source

package.lisp.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


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.


5.2 Internals


5.2.1 Special variables

Special Variable: *base32-alphabet*
Package

cl-base32.

Source

base32.lisp.


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.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*base32-alphabet*: Private special variables

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