The rfc2388 Reference Manual

This is the rfc2388 Reference Manual, version 1.5, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:36:29 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 rfc2388

Implementation of RFC 2388

Author

Janis Dzerins <>

License

Simplified BSD

Long Description

Contains an implementation of RFC 2388, which is used to process form data posted with HTTP POST method using enctype "multipart/form-data".

Version

1.5

Source

rfc2388.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 rfc2388/rfc2388.asd

Source

rfc2388.asd.

Parent Component

rfc2388 (system).

ASDF Systems

rfc2388.


3.1.2 rfc2388/rfc2388.lisp

Dependency

packages.lisp (file).

Source

rfc2388.asd.

Parent Component

rfc2388 (system).

Public Interface
Internals

3.1.3 rfc2388/packages.lisp

Source

rfc2388.asd.

Parent Component

rfc2388 (system).

Packages

rfc2388.


4 Packages

Packages are listed by definition order.


4.1 rfc2388

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

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: content-type (part &key as-string)

Returns the Content-Type header of mime-part PART.

Package

rfc2388.

Source

rfc2388.lisp.

Function: find-content-disposition-header (headers)
Package

rfc2388.

Source

rfc2388.lisp.

Function: find-header (label headers)

Find header by label from set of headers.

Package

rfc2388.

Source

rfc2388.lisp.

Function: find-parameter (name params)

Find header parameter by name from set of parameters.

Package

rfc2388.

Source

rfc2388.lisp.

Function: get-file-name (headers)
Package

rfc2388.

Source

rfc2388.lisp.

Function: header-name (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: (setf header-name) (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: header-parameters (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: (setf header-parameters) (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: header-value (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: (setf header-value) (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: make-mime-part (contents headers)
Package

rfc2388.

Source

rfc2388.lisp.

Function: mime-part-contents (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: (setf mime-part-contents) (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: mime-part-headers (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: (setf mime-part-headers) (structure)
Package

rfc2388.

Source

rfc2388.lisp.


5.1.2 Generic functions

Generic Function: parse-header (source &optional start-state)

Parses SOURCE and returs a single MIME header.

Header is a list of the form (NAME VALUE PARAMETERS), PARAMETERS is a list of (NAME . VALUE)

Package

rfc2388.

Source

rfc2388.lisp.

Methods
Method: parse-header ((stream stream) &optional start-state)

Returns a MIME part header, or NIL, if there is no header. Header is terminated by CRLF.

Method: parse-header ((source string) &optional start-state)
Generic Function: parse-mime (source boundary &key write-content-to-file)

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.

Package

rfc2388.

Source

rfc2388.lisp.

Methods
Method: parse-mime ((input stream) boundary &key write-content-to-file)
Method: parse-mime ((input string) separator &key write-content-to-file)

5.2 Internals


5.2.1 Ordinary functions

Function: content-type-sub (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: (setf content-type-sub) (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: content-type-super (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: (setf content-type-super) (structure)
Package

rfc2388.

Source

rfc2388.lisp.

Function: copy-content-type (sequence)

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

rfc2388.

Alias for

copy-seq.

Function: copy-header (sequence)

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

rfc2388.

Alias for

copy-seq.

Function: copy-mime-part (sequence)

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

rfc2388.

Alias for

copy-seq.

Function: lwsp-char-p (char)

Returns true if CHAR is a linear-whitespace-char (LWSP-char). Either space or tab, in short.

Package

rfc2388.

Source

rfc2388.lisp.

Function: make-content-type (super sub)
Package

rfc2388.

Source

rfc2388.lisp.

Function: make-header (name value parameters)
Package

rfc2388.

Source

rfc2388.lisp.

Function: make-tmp-file-name ()
Package

rfc2388.

Source

rfc2388.lisp.

Function: parse-content-type (string)

Returns content-type which is parsed from STRING.

Package

rfc2388.

Source

rfc2388.lisp.

Function: read-until-next-boundary (stream boundary &optional discard out-stream)

Reads from STREAM up to the next boundary. Returns two values: read data (nil if DISCARD is true), and true if the boundary is not last (i.e., there’s more data).

Package

rfc2388.

Source

rfc2388.lisp.

Function: skip-linear-whitespace (string &key start end)

Returns the position of first non-linear-whitespace character in STRING bound by START and END.

Package

rfc2388.

Source

rfc2388.lisp.

Function: unparse-content-type (ct)

Returns content-type CT in string representation.

Package

rfc2388.

Source

rfc2388.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   F   G   H   L   M   P   R   S   U  
Index Entry  Section

(
(setf content-type-sub): Private ordinary functions
(setf content-type-super): Private ordinary functions
(setf header-name): Public ordinary functions
(setf header-parameters): Public ordinary functions
(setf header-value): Public ordinary functions
(setf mime-part-contents): Public ordinary functions
(setf mime-part-headers): Public ordinary functions

C
content-type: Public ordinary functions
content-type-sub: Private ordinary functions
content-type-super: Private ordinary functions
copy-content-type: Private ordinary functions
copy-header: Private ordinary functions
copy-mime-part: Private ordinary functions

F
find-content-disposition-header: Public ordinary functions
find-header: Public ordinary functions
find-parameter: Public ordinary functions
Function, (setf content-type-sub): Private ordinary functions
Function, (setf content-type-super): Private ordinary functions
Function, (setf header-name): Public ordinary functions
Function, (setf header-parameters): Public ordinary functions
Function, (setf header-value): Public ordinary functions
Function, (setf mime-part-contents): Public ordinary functions
Function, (setf mime-part-headers): Public ordinary functions
Function, content-type: Public ordinary functions
Function, content-type-sub: Private ordinary functions
Function, content-type-super: Private ordinary functions
Function, copy-content-type: Private ordinary functions
Function, copy-header: Private ordinary functions
Function, copy-mime-part: Private ordinary functions
Function, find-content-disposition-header: Public ordinary functions
Function, find-header: Public ordinary functions
Function, find-parameter: Public ordinary functions
Function, get-file-name: Public ordinary functions
Function, header-name: Public ordinary functions
Function, header-parameters: Public ordinary functions
Function, header-value: Public ordinary functions
Function, lwsp-char-p: Private ordinary functions
Function, make-content-type: Private ordinary functions
Function, make-header: Private ordinary functions
Function, make-mime-part: Public ordinary functions
Function, make-tmp-file-name: Private ordinary functions
Function, mime-part-contents: Public ordinary functions
Function, mime-part-headers: Public ordinary functions
Function, parse-content-type: Private ordinary functions
Function, read-until-next-boundary: Private ordinary functions
Function, skip-linear-whitespace: Private ordinary functions
Function, unparse-content-type: Private ordinary functions

G
Generic Function, parse-header: Public generic functions
Generic Function, parse-mime: Public generic functions
get-file-name: Public ordinary functions

H
header-name: Public ordinary functions
header-parameters: Public ordinary functions
header-value: Public ordinary functions

L
lwsp-char-p: Private ordinary functions

M
make-content-type: Private ordinary functions
make-header: Private ordinary functions
make-mime-part: Public ordinary functions
make-tmp-file-name: Private ordinary functions
Method, parse-header: Public generic functions
Method, parse-header: Public generic functions
Method, parse-mime: Public generic functions
Method, parse-mime: Public generic functions
mime-part-contents: Public ordinary functions
mime-part-headers: Public ordinary functions

P
parse-content-type: Private ordinary functions
parse-header: Public generic functions
parse-header: Public generic functions
parse-header: Public generic functions
parse-mime: Public generic functions
parse-mime: Public generic functions
parse-mime: Public generic functions

R
read-until-next-boundary: Private ordinary functions

S
skip-linear-whitespace: Private ordinary functions

U
unparse-content-type: Private ordinary functions


A.3 Variables