This is the rfc2388-binary Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:36:31 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
rfc2388-binary/sourcerfc2388-binary (system).
packages.lisp (file).
utils.lisp (file).
api.lisp (file).
parsing.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
rfc2388-binary/rfc2388-binary.asdrfc2388-binary/source/packages.lisprfc2388-binary/source/utils.lisprfc2388-binary/source/api.lisprfc2388-binary/source/parsing.lisprfc2388-binary/rfc2388-binary.asdrfc2388-binary (system).
rfc2388-binary/source/utils.lisppackages.lisp (file).
source (module).
*debug* (special variable).
as-ascii-char (function).
ascii-string-to-boundary-array (function).
debug-message (macro).
linear-whitespace-byte? (function).
make-mime-buffer-writer (function).
make-mime-file-writer (function).
mime-part-headers-to-alist (function).
rfc2388-binary/source/api.lisppackages.lisp (file).
utils.lisp (file).
source (module).
content (reader method).
(setf content) (writer method).
content-charset (reader method).
(setf content-charset) (writer method).
content-length (reader method).
(setf content-length) (writer method).
content-type (reader method).
(setf content-type) (writer method).
get-header (generic function).
get-header-attribute (generic function).
header-attributes (reader method).
(setf header-attributes) (writer method).
header-name (reader method).
(setf header-name) (writer method).
header-value (reader method).
(setf header-value) (writer method).
headers (reader method).
(setf headers) (writer method).
mime-part (class).
mime-part-p (generic function).
parse-mime (function).
print-mime-part (function).
read-mime (generic function).
mime-header (class).
rfc2388-binary/source/parsing.lisppackages.lisp (file).
utils.lisp (file).
api.lisp (file).
source (module).
parse-header-value (function).
read-mime (method).
read-mime (method).
read-mime (method).
parse-key-values (function).
read-next-header (function).
read-until-next-boundary (function).
Packages are listed by definition order.
rfc2388-binarycommon-lisp.
content (generic reader).
(setf content) (generic writer).
content-charset (generic reader).
(setf content-charset) (generic writer).
content-length (generic reader).
(setf content-length) (generic writer).
content-type (generic reader).
(setf content-type) (generic writer).
get-header (generic function).
get-header-attribute (generic function).
header-attributes (generic reader).
(setf header-attributes) (generic writer).
header-name (generic reader).
(setf header-name) (generic writer).
header-value (generic reader).
(setf header-value) (generic writer).
headers (generic reader).
(setf headers) (generic writer).
mime-part (class).
mime-part-p (generic function).
parse-header-value (function).
parse-mime (function).
print-mime-part (function).
read-mime (generic function).
*debug* (special variable).
as-ascii-char (function).
ascii-string-to-boundary-array (function).
debug-message (macro).
linear-whitespace-byte? (function).
make-mime-buffer-writer (function).
make-mime-file-writer (function).
mime-header (class).
mime-part-headers-to-alist (function).
parse-key-values (function).
read-next-header (function).
read-until-next-boundary (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the value in header-value-string and any associated attributes.
Parses MIME entities, returning them as a list.
Each element in the list is of form: (body headers), where BODY is the
contents of MIME part, and HEADERS are all headers for that part.
BOUNDARY is a string used to separate MIME entities.
This is the convenience interface to READ-MIME, all data is read
into memory or a file and we assume that every byte in the data
corresponds to exactly one character.
The SOURCE and BOUNDARY arguments are passed unchanged to READ-MIME. See READ-MIME’s documentation for details.
Returns the mime-header object for the header named HEADER-NAME (a string).
Returns the value of the attribute named NAME in the header HEADER.
mime-header) (name string)) ¶mime-header)) ¶automatically generated reader method
mime-header)) ¶automatically generated writer method
mime-header)) ¶automatically generated reader method
mime-header)) ¶automatically generated writer method
mime-header)) ¶automatically generated reader method
mime-header)) ¶automatically generated writer method
Parses the MIME entites in SOURCE.
SOURCE is either a vector of (unsigned-byte 8) or a stream whose
element-type is (unsigned-byte 8). BOUNDARY is either a string of
US-ASCII encodeable characters or a byte vector. CALLBACK is a
function which will be passed one argument, a MIME-PART
containing the headers of the mime part and must return the following
values:
- a byte-handler function. This is a one argument function which
will be passed every byte in the mime part’s content.
- a termination function. This is a function without arguments
and will be called when the operation finishes without errors.
It must return whatever is to be returned from read-mime.
- an optional abort function. This is a function without arguments and will be called when the operation is aborted due to an error.
READ-MIME consumes bytes from SOURCE and returns a list of the
whatever the various termination functions returned.
Example:
(read-mime #<a binary stream> "123"
(lambda (mime-part)
(values (lambda (byte) (collect-byte-somewhere byte))
(lambda () mime-part))))
This call would return a list of mime-part objects passing each
byte to collect-byte-somewhere.
You may also want to look at UCW for a real-world example.
When T we compile the code with some logging statements built in.
Assuming BYTE is an ASCII coded character retun the corresponding character.
In short: is it a space or a tab?
Returns an alist of the keys and values in KEY-VALUE-STRING.
KEY-VALUE-STRING is of the form: (w+="w+";)*
Reads the next header from STREAM. Returns, as the first
value, T if a header was found and NIL otherwise. When a header
is found two more values are returned: the header name (a
string) and the header value (also a string). Headers are
assumed to be encoded in 7bit ASCII.
The returned strings may actually be displaced arrays.
Reads from STREAM up to the next boundary. For every byte of
data in stream we call DATA-HANDLER passing it the byte. Returns
T if there’s more data to be read, NIL otherwise.
The ASSUME-FIRST-BOUNDARY parameter should T if we’re reading the first part of a MIME message, where there is no leading CR LF sequence.
| Jump to: | (
A C D F G H L M P R |
|---|
| Jump to: | (
A C D F G H L M P R |
|---|
| Jump to: | *
A C H N S V |
|---|
| Jump to: | *
A C H N S V |
|---|
| Jump to: | A C F M P R S U |
|---|
| Jump to: | A C F M P R S U |
|---|