The cl-base32 Reference Manual

Table of Contents

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

The cl-base32 Reference Manual

This is the cl-base32 Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:58:28 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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.

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 cl-base32

Version

0.1

Source

cl-base32.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-base32.asd

Location

cl-base32.asd

Systems

cl-base32 (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-base32/package.lisp

Parent

cl-base32 (system)

Location

package.lisp

Packages

Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-base32/base32.lisp

Dependency

package.lisp (file)

Parent

cl-base32 (system)

Location

base32.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 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
Internal Definitions

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

4.2 cl-base32-asd

Source

package.lisp (file)

Use List

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

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)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *base32-alphabet*
Package

cl-base32

Source

base32.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-base32.asd: The cl-base32<dot>asd file
cl-base32/base32.lisp: The cl-base32/base32<dot>lisp file
cl-base32/package.lisp: The cl-base32/package<dot>lisp file

F
File, Lisp, cl-base32.asd: The cl-base32<dot>asd file
File, Lisp, cl-base32/base32.lisp: The cl-base32/base32<dot>lisp file
File, Lisp, cl-base32/package.lisp: The cl-base32/package<dot>lisp file

L
Lisp File, cl-base32.asd: The cl-base32<dot>asd file
Lisp File, cl-base32/base32.lisp: The cl-base32/base32<dot>lisp file
Lisp File, cl-base32/package.lisp: The cl-base32/package<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   B   D   E   F   R   U   W  
Index Entry  Section

B
base32-length-from-bytes: Internal functions
base32-to-bytes: Exported functions
byte-length-from-base32: Internal functions
bytes-to-base32: Exported functions

D
decode-word: Internal functions

E
encode-word: Internal functions

F
Function, base32-length-from-bytes: Internal functions
Function, base32-to-bytes: Exported functions
Function, byte-length-from-base32: Internal functions
Function, bytes-to-base32: Exported functions
Function, decode-word: Internal functions
Function, encode-word: Internal functions
Function, read-word: Internal functions
Function, unpadded-base32-length: Internal functions
Function, write-word: Internal functions

R
read-word: Internal functions

U
unpadded-base32-length: Internal functions

W
write-word: Internal functions

Jump to:   B   D   E   F   R   U   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*base32-alphabet*: Internal special variables

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

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-base32: The cl-base32 system
cl-base32: The cl-base32 package
cl-base32-asd: The cl-base32-asd package

P
Package, cl-base32: The cl-base32 package
Package, cl-base32-asd: The cl-base32-asd package

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

Jump to:   C   P   S