The rfc2388-binary Reference Manual

Table of Contents

The rfc2388-binary Reference Manual

This is the rfc2388-binary Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:31:20 2018 GMT+0.

1 Systems

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

1.1 rfc2388-binary

Source

rfc2388-binary.asd (file)

Components

• rfc2388-binary.asd (file)
• source (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 rfc2388-binary/source

Parent

rfc2388-binary (system)

Location

source/

Components

• packages.lisp (file)
• utils.lisp (file)
• api.lisp (file)
• parsing.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 rfc2388-binary.asd

Location

rfc2388-binary.asd

Systems

rfc2388-binary (system)

3.1.2 rfc2388-binary/source/packages.lisp

Parent

source (module)

Location

source/packages.lisp

Packages

rfc2388-binary

3.1.3 rfc2388-binary/source/utils.lisp

Dependency

packages.lisp (file)

Parent

source (module)

Location

source/utils.lisp

Internal Definitions

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

3.1.4 rfc2388-binary/source/api.lisp

Dependencies

• packages.lisp (file)
• utils.lisp (file)

Parent

source (module)

Location

source/api.lisp

Exported Definitions

• content (method)
• (setf content) (method)
• content-charset (method)
• (setf content-charset) (method)
• content-length (method)
• (setf content-length) (method)
• content-type (method)
• (setf content-type) (method)
• get-header (generic function)
• get-header (method)
• get-header-attribute (generic function)
• get-header-attribute (method)
• header-attributes (method)
• (setf header-attributes) (method)
• header-name (method)
• (setf header-name) (method)
• header-value (method)
• (setf header-value) (method)
• headers (method)
• (setf headers) (method)
• mime-part (class)
• mime-part-p (generic function)
• mime-part-p (method)
• mime-part-p (method)
• parse-mime (function)
• print-mime-part (function)
• read-mime (generic function)

Internal Definitions

mime-header (class)

3.1.5 rfc2388-binary/source/parsing.lisp

Dependencies

• packages.lisp (file)
• utils.lisp (file)
• api.lisp (file)

Parent

source (module)

Location

source/parsing.lisp

Exported Definitions

• parse-header-value (function)
• read-mime (method)
• read-mime (method)
• read-mime (method)

Internal Definitions

• parse-key-values (function)
• read-next-header (function)
• read-until-next-boundary (function)

3.2 Other

3.2.1 rfc2388-binary/rfc2388-binary.asd

Parent

rfc2388-binary (system)

Location

rfc2388-binary.asd

4 Packages

Packages are listed by definition order.

4.1 rfc2388-binary

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• content (generic function)
• content (method)
• (setf content) (method)
• (setf content) (generic function)
• content-charset (generic function)
• content-charset (method)
• (setf content-charset) (method)
• (setf content-charset) (generic function)
• content-length (generic function)
• content-length (method)
• (setf content-length) (method)
• (setf content-length) (generic function)
• content-type (generic function)
• content-type (method)
• (setf content-type) (method)
• (setf content-type) (generic function)
• get-header (generic function)
• get-header (method)
• get-header-attribute (generic function)
• get-header-attribute (method)
• header-attributes (generic function)
• header-attributes (method)
• (setf header-attributes) (method)
• (setf header-attributes) (generic function)
• header-name (generic function)
• header-name (method)
• (setf header-name) (method)
• (setf header-name) (generic function)
• header-value (generic function)
• header-value (method)
• (setf header-value) (method)
• (setf header-value) (generic function)
• headers (generic function)
• headers (method)
• (setf headers) (method)
• (setf headers) (generic function)
• mime-part (class)
• mime-part-p (generic function)
• mime-part-p (method)
• mime-part-p (method)
• parse-header-value (function)
• parse-mime (function)
• print-mime-part (function)
• read-mime (generic function)
• read-mime (method)
• read-mime (method)
• read-mime (method)

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: parse-header-value ()

Returns the value in header-value-string and any associated attributes.

Package

rfc2388-binary

Source

parsing.lisp (file)

Function: parse-mime SOURCE BOUNDARY &key WRITE-CONTENT-TO-FILE BYTE-ENCODER

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.

Package

rfc2388-binary

Source

api.lisp (file)

Function: print-mime-part PART &optional STREAM

Package

rfc2388-binary

Source

api.lisp (file)

5.1.2 Generic functions

Generic Function: content OBJECT

Generic Function: (setf content) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: content (MIME-PART mime-part)

automatically generated reader method

Source

api.lisp (file)

Method: (setf content) NEW-VALUE (MIME-PART mime-part)

automatically generated writer method

Source

api.lisp (file)

Generic Function: content-charset OBJECT

Generic Function: (setf content-charset) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: content-charset (MIME-PART mime-part)

automatically generated reader method

Source

api.lisp (file)

Method: (setf content-charset) NEW-VALUE (MIME-PART mime-part)

automatically generated writer method

Source

api.lisp (file)

Generic Function: content-length OBJECT

Generic Function: (setf content-length) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: content-length (MIME-PART mime-part)

automatically generated reader method

Source

api.lisp (file)

Method: (setf content-length) NEW-VALUE (MIME-PART mime-part)

automatically generated writer method

Source

api.lisp (file)

Generic Function: content-type OBJECT

Generic Function: (setf content-type) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: content-type (MIME-PART mime-part)

automatically generated reader method

Source

api.lisp (file)

Method: (setf content-type) NEW-VALUE (MIME-PART mime-part)

automatically generated writer method

Source

api.lisp (file)

Generic Function: get-header PART HEADER-NAME

Returns the mime-header object for the header named HEADER-NAME (a string).

Package

rfc2388-binary

Source

api.lisp (file)

Methods

Method: get-header (PART mime-part) (HEADER-NAME string)

Generic Function: get-header-attribute HEADER NAME

Returns the value of the attribute named NAME in the header HEADER.

Package

rfc2388-binary

Source

api.lisp (file)

Methods

Method: get-header-attribute (HEADER mime-header) (NAME string)

Generic Function: header-attributes OBJECT

Generic Function: (setf header-attributes) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: header-attributes (MIME-HEADER mime-header)

automatically generated reader method

Source

api.lisp (file)

Method: (setf header-attributes) NEW-VALUE (MIME-HEADER mime-header)

automatically generated writer method

Source

api.lisp (file)

Generic Function: header-name OBJECT

Generic Function: (setf header-name) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: header-name (MIME-HEADER mime-header)

automatically generated reader method

Source

api.lisp (file)

Method: (setf header-name) NEW-VALUE (MIME-HEADER mime-header)

automatically generated writer method

Source

api.lisp (file)

Generic Function: header-value OBJECT

Generic Function: (setf header-value) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: header-value (MIME-HEADER mime-header)

automatically generated reader method

Source

api.lisp (file)

Method: (setf header-value) NEW-VALUE (MIME-HEADER mime-header)

automatically generated writer method

Source

api.lisp (file)

Generic Function: headers OBJECT

Generic Function: (setf headers) NEW-VALUE OBJECT

Package

rfc2388-binary

Methods

Method: headers (MIME-PART mime-part)

automatically generated reader method

Source

api.lisp (file)

Method: (setf headers) NEW-VALUE (MIME-PART mime-part)

automatically generated writer method

Source

api.lisp (file)

Generic Function: mime-part-p OBJECT

Package

rfc2388-binary

Source

api.lisp (file)

Methods

Method: mime-part-p (OBJECT mime-part)

Method: mime-part-p OBJECT

Generic Function: read-mime SOURCE BOUNDARY CALLBACK

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.

Package

rfc2388-binary

Source

api.lisp (file)

Methods

Method: read-mime (SOURCE stream) (BOUNDARY array) CALLBACK-FACTORY

Source

parsing.lisp (file)

Method: read-mime (SOURCE stream) (BOUNDARY string) CALLBACK-FACTORY

Source

parsing.lisp (file)

Method: read-mime (SOURCE string) BOUNDARY CALLBACK-FACTORY

Source

parsing.lisp (file)

5.1.3 Classes

Class: mime-part ()

Package

rfc2388-binary

Source

api.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• get-header (method)
• mime-part-p (method)
• headers (method)
• headers (method)
• content-charset (method)
• content-charset (method)
• content-type (method)
• content-type (method)
• content-length (method)
• content-length (method)
• content (method)
• content (method)

Direct slots

Slot: content

Readers

content (generic function)

Writers

(setf content) (generic function)

Slot: content-length

Readers

content-length (generic function)

Writers

(setf content-length) (generic function)

Slot: content-type

Readers

content-type (generic function)

Writers

(setf content-type) (generic function)

Slot: content-charset

Readers

content-charset (generic function)

Writers

(setf content-charset) (generic function)

Slot: headers

Initform

(quote nil)

Readers

headers (generic function)

Writers

(setf headers) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *debug*

When T we compile the code with some logging statements built in.

Package

rfc2388-binary

Source

utils.lisp (file)

5.2.2 Macros

Macro: debug-message MESSAGE &rest MESSAGE-CONTROL

Package

rfc2388-binary

Source

utils.lisp (file)

5.2.3 Functions

Function: as-ascii-char BYTE

Assuming BYTE is an ASCII coded character retun the corresponding character.

Package

rfc2388-binary

Source

utils.lisp (file)

Function: ascii-string-to-boundary-array STRING

Package

rfc2388-binary

Source

utils.lisp (file)

Function: linear-whitespace-byte? BYTE

In short: is it a space or a tab?

Package

rfc2388-binary

Source

utils.lisp (file)

Function: make-mime-buffer-writer &key BYTE-ENCODER

Package

rfc2388-binary

Source

utils.lisp (file)

Function: make-mime-file-writer FILE-NAME &key BYTE-ENCODER

Package

rfc2388-binary

Source

utils.lisp (file)

Function: mime-part-headers-to-alist MIME-PART CONTENT

Package

rfc2388-binary

Source

utils.lisp (file)

Function: parse-key-values ()

Returns an alist of the keys and values in KEY-VALUE-STRING.

KEY-VALUE-STRING is of the form: (w+="w+";)*

Package

rfc2388-binary

Source

parsing.lisp (file)

Function: read-next-header ()

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.

Package

rfc2388-binary

Source

parsing.lisp (file)

Function: read-until-next-boundary ()

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.

Package

rfc2388-binary

Source

parsing.lisp (file)

5.2.4 Classes

Class: mime-header ()

Package

rfc2388-binary

Source

api.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• get-header-attribute (method)
• header-attributes (method)
• header-attributes (method)
• header-value (method)
• header-value (method)
• header-name (method)
• header-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

header-name (generic function)

Writers

(setf header-name) (generic function)

Slot: value

Initargs

:value

Readers

header-value (generic function)

Writers

(setf header-value) (generic function)

Slot: attributes

Initargs

:attributes

Readers

header-attributes (generic function)

Writers

(setf header-attributes) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types