This is the qbase64 Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:38:13 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
qbase64Fast and flexible base64 encoder and decoder
Chaitanya Gupta <mail@chaitanyagupta.com>
BSD-3-Clause
0.3.0
trivial-gray-streams (system).
metabang-bind (system).
package.lisp (file).
utils.lisp (file).
stream-utils.lisp (file).
qbase64.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
qbase64/qbase64.asdqbase64/package.lispqbase64/utils.lispqbase64/stream-utils.lispqbase64/qbase64.lispqbase64/utils.lisppackage.lisp (file).
qbase64 (system).
bytes (function).
define-constant (macro).
defun/td (macro).
least-multiple-upfrom (function).
make-byte-vector (function).
parse-body (function).
positive-fixnum (type).
qbase64/stream-utils.lisputils.lisp (file).
qbase64 (system).
close (method).
input-stream-p (method).
open-stream-p (method).
output-stream-p (method).
stream-mixin (class).
stream-open-p (reader method).
(setf stream-open-p) (writer method).
qbase64/qbase64.lispstream-utils.lisp (file).
qbase64 (system).
+max-bytes-length+ (constant).
+max-string-length+ (constant).
close (method).
decode (function).
decode-stream (class).
decode-string (function).
decoder (structure).
encode (function).
encode-bytes (function).
encode-stream (class).
encoder (structure).
initialize-instance (method).
initialize-instance (method).
input-stream-p (method).
make-decoder (function).
make-encoder (function).
output-stream-p (method).
stream-element-type (method).
stream-element-type (method).
stream-finish-output (method).
stream-force-output (method).
stream-read-byte (method).
stream-read-sequence (method).
stream-write-byte (method).
stream-write-sequence (method).
%decode (function).
%encode (function).
%make-decoder (function).
%make-encoder (function).
%stream-write-sequence (function).
+empty-bytes+ (constant).
+empty-string+ (constant).
+original-reverse-set+ (constant).
+original-set+ (constant).
+pad-char+ (constant).
+uri-reverse-set+ (constant).
+uri-set+ (constant).
copy-decoder (function).
copy-encoder (function).
decode-length (function).
decoder-p (function).
decoder-pchars (reader).
(setf decoder-pchars) (writer).
decoder-pchars-end (reader).
(setf decoder-pchars-end) (writer).
decoder-scheme (reader).
(setf decoder-scheme) (writer).
encode-length (function).
encoder-finish-p (reader).
(setf encoder-finish-p) (writer).
encoder-p (function).
encoder-pbytes (reader).
(setf encoder-pbytes) (writer).
encoder-pbytes-end (reader).
(setf encoder-pbytes-end) (writer).
encoder-scheme (reader).
(setf encoder-scheme) (writer).
fill-pchars (function).
flush-pending-bytes (function).
resize-pchars (function).
reverse-set (function).
scheme (type).
whitespace-p (function).
write-buffer-to-sequence (function).
Packages are listed by definition order.
qbase64common-lisp.
trivial-gray-streams.
+max-bytes-length+ (constant).
+max-string-length+ (constant).
decode (function).
decode-stream (class).
decode-string (function).
decoder (structure).
encode (function).
encode-bytes (function).
encode-stream (class).
encoder (structure).
make-decoder (function).
make-encoder (function).
%decode (function).
%encode (function).
%make-decoder (function).
%make-encoder (function).
%stream-write-sequence (function).
+empty-bytes+ (constant).
+empty-string+ (constant).
+original-reverse-set+ (constant).
+original-set+ (constant).
+pad-char+ (constant).
+uri-reverse-set+ (constant).
+uri-set+ (constant).
bytes (function).
copy-decoder (function).
copy-encoder (function).
decode-length (function).
decoder-p (function).
decoder-pchars (reader).
(setf decoder-pchars) (writer).
decoder-pchars-end (reader).
(setf decoder-pchars-end) (writer).
decoder-scheme (reader).
(setf decoder-scheme) (writer).
define-constant (macro).
defun/td (macro).
encode-length (function).
encoder-finish-p (reader).
(setf encoder-finish-p) (writer).
encoder-p (function).
encoder-pbytes (reader).
(setf encoder-pbytes) (writer).
encoder-pbytes-end (reader).
(setf encoder-pbytes-end) (writer).
encoder-scheme (reader).
(setf encoder-scheme) (writer).
fill-pchars (function).
flush-pending-bytes (function).
least-multiple-upfrom (function).
make-byte-vector (function).
parse-body (function).
positive-fixnum (type).
resize-pchars (function).
reverse-set (function).
scheme (type).
stream-mixin (class).
stream-open-p (generic reader).
(setf stream-open-p) (generic writer).
whitespace-p (function).
write-buffer-to-sequence (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Max length of the byte array that is used as encoding input or decoding output
Max length of the string that is used as encoding output or decoding input
Decodes the given STRING and writes the resultant bytes to BYTES.
DECODER: The decoder
STRING: The string to decode.
BYTES: This is where the resultant bytes are written into. Should be
a single-dimentional array of (UNSIGNED-BYTE 8) elements.
START1, END1: Bounds for STRING
START2, END2: Bounds for BYTES
Whitespace in string is ignored. It is not necessary that the entire
STRING is decoded in one go. For example,
* There may not be enough space left in BYTES,
* or the length of the string (minus whitespace chars) may not be a
multiple of 4 (base64 decoding works on groups of four characters at
at time).
In these cases, DECODE will decode as much of the string as it can and
write the resultant bytes into BYTES. The remaining string is copied
to an internal buffer by the decoder and used the next time DECODE is
called. Also, the second return value (called PENDINGP, see below) is
set to true.
DECODE can be given an empty STRING in which case the buffered string
is decoded as much as possible.
Returns POSITION, PENDINGP.
POSITION: First index of BYTES that wasn’t updated
PENDINGP: True if not all of the STRING was decoded
Decodes base64 chars in STRING and returns an array
of (UNSIGNED-BYTE 8) elements.
STRING: The string to decode.
SCHEME: The base64 encoding scheme to use. Must be :ORIGINAL (default) or :URI.
Encodes given BYTES and writes the resultant chars to STRING.
ENCODER: The encoder
BYTES: Should be a single-dimentional array of (UNSIGNED-BYTE 8)
elements.
STRING: The encoded characters are written into this string.
START1, END1: Bounds for BYTES
START2, END2: Bounds for STRING
FINISH: Padding characters are output if required, and no new bytes
can be accepted until all the pending bytes are written out.
It is not necessary that all of BYTES are encoded in one go. For
example,
* There may not be enough space left in STRING
* FINISH is not true and the cumulative length of all the bytes given
till now is not a multiple of 3 (base64 encoding works on groups of
three bytes).
In these cases, as much as possible BYTES are encoded and the
resultant chars written into STRING, the remaining bytes are copied to
an internal buffer by the encoder and used the next time ENCODE is
called. Also, the second value returned (called PENDINGP, see below)
is set to true.
If FINISH is true but cumulative length of all the BYTES is not a
multiple of 3, padding characters are written into STRING.
ENCODE can be given an empty BYTES array in which case the internal
buffer is encoded as much as possible.
Returns POSITION, PENDINGP.
POSITION: First index of STRING that wasn’t updated
PENDINGP: True if not all BYTES were encoded
Encode BYTES to base64 and return the string.
BYTES: Should be a single-dimentional array of (UNSIGNED-BYTE 8)
elements.
SCHEME: The base64 encoding scheme to use. Must
be :ORIGINAL (default) or :URI.
LINEBREAK: If 0 (the default), no linebreaks are written. Otherwise its value must be the max number of characters per line.
Creates a DECODER.
SCHEME: The base64 encoding scheme to use. Can be :ORIGINAL or :URI
Creates an ENCODER.
SCHEME: The base64 encoding scheme to use. Can be :ORIGINAL or :URI
encode-stream) &key abort) ¶stream-mixin) &key abort) ¶decode-stream) &key scheme) ¶encode-stream) &key scheme) ¶decode-stream)) ¶stream-mixin)) ¶stream-mixin)) ¶encode-stream)) ¶stream-mixin)) ¶decode-stream)) ¶encode-stream)) ¶encode-stream)) ¶sb-gray.
encode-stream)) ¶sb-gray.
decode-stream)) ¶sb-gray.
decode-stream) sequence start end &key) ¶trivial-gray-streams.
encode-stream) integer) ¶sb-gray.
encode-stream) sequence start end &key) ¶trivial-gray-streams.
Use a DECODER to decode base64 characters to bytes. Use MAKE-DECODER to create a decoder, then decode base64 chars using DECODE.
Use an ENCODER to encode bytes to string. Create an encoder using MAKE-ENCODER, then start encoding bytes using ENCODE.
structure-object.
qbase64::scheme
:original
(simple-array (unsigned-byte 8))
qbase64::+empty-bytes+
qbase64::positive-fixnum
0
A binary input stream that converts base64 chars from an
underlying stream to bytes.
Create a DECODE-STREAM using MAKE-INSTANCE. The following
initialization keywords are provided:
UNDERLYING-STREAM: The underlying character input stream from which
base64 chars are read. Must be given.
SCHEME: The base64 encoding scheme to use. Must
be :ORIGINAL (default) or :URI.
Note that DECODE-STREAM does not close the underlying stream when CLOSE is invoked.
fundamental-binary-input-stream.
stream-mixin.
trivial-gray-stream-mixin.
:underlying-stream
common-lisp.
qbase64::+empty-string+
(qbase64::make-byte-vector 3)
0
(qbase64::make-byte-vector 1)
A binary output stream that converts bytes to base64 characters
and writes them to an underlyihng character output stream.
Create an ENCODE-STREAM using MAKE-INSTANCE. The following
initialization keywords are provided:
UNDERLYING-STREAM: The underlying character output stream to which
base64 characters are written. Must be given.
SCHEME: The base64 encoding scheme to use. Must
be :ORIGINAL (default) or :URI.
LINEBREAK: If 0 (the default), no linebreaks are written. Otherwise
its value must be the max number of characters per line.
Note that ENCODE-STREAM does not close the underlying stream when CLOSE is invoked.
fundamental-binary-output-stream.
stream-mixin.
trivial-gray-stream-mixin.
:underlying-stream
common-lisp.
qbase64::+empty-string+
(qbase64::make-byte-vector 1)
0
:linebreak
0
Parses BODY into (values remaining-forms declarations doc-string). Documentation strings are recognized only if DOCUMENTATION is true. Syntax errors in body are signalled and WHOLE is used in the signal arguments when given.
Returns T for a whitespace character.
stream-mixin)) ¶automatically generated reader method
stream-mixin)) ¶automatically generated writer method
t
| Jump to: | %
(
B C D E F G I L M O P R S W |
|---|
| Jump to: | %
(
B C D E F G I L M O P R S W |
|---|
| Jump to: | +
B C D E F L O P S U |
|---|
| Jump to: | +
B C D E F L O P S U |
|---|
| Jump to: | C D E F P Q S T U |
|---|
| Jump to: | C D E F P Q S T U |
|---|