The cl-mimeparse Reference Manual

Table of Contents

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

The cl-mimeparse Reference Manual

This is the cl-mimeparse Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 09:52:30 2021 GMT+0.


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

1 Introduction

cl-mimeparse

Library for parsing MIME types, in the spirit of http://code.google.com/p/mimeparse/, with a Common Lisp flavor.

License

MIT


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-mimeparse

Author

Nathan Froyd <froydnj@gmail.com>

Home Page

https://github.com/mmontone/cl-mimeparse

License

MIT

Description

Library for parsing MIME types, in the spirit of http://code.google.com/p/mimeparse/, with a Common Lisp flavor.

Version

0.0.1

Dependencies
Source

cl-mimeparse.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-mimeparse.asd

Location

cl-mimeparse.asd

Systems

cl-mimeparse (system)


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

3.1.2 cl-mimeparse/package.lisp

Parent

cl-mimeparse (system)

Location

package.lisp

Packages

mimeparse


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

3.1.3 cl-mimeparse/mimeparse.lisp

Dependency

package.lisp (file)

Parent

cl-mimeparse (system)

Location

mimeparse.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 mimeparse

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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


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

5.1.1 Functions

Function: best-match SUPPORTED HEADER

Return the best match for all media-ranges in HEADER. SUPPORTED is a list of supported MIME types. The value of HEADER must be a string that conforms to the format of the HTTP Accept: header.

Package

mimeparse

Source

mimeparse.lisp (file)

Function: parse-media-range MEDIA-RANGE-STRING

Parses MEDIA-RANGE-STRING and returns a media-range object. The returned media-range always has a value for the ‘q’ parameter; a proper default is suppplied if one is not provided in MEDIA-RANGE-STRING.

Package

mimeparse

Source

mimeparse.lisp (file)


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

5.1.2 Generic functions

Generic Function: quality MIME-TYPE RANGES

Returns the quality ‘q’ of MIME-TYPE when compared
against the media-ranges in RANGES. RANGES can be either a list or a string. If RANGES is a list, it should be a list of media-ranges as returned by PARSE-MEDIA-RANGE. If RANGES is a string, it should be a string that conforms to the format of the HTTP Accept: header.

Package

mimeparse

Source

mimeparse.lisp (file)

Methods
Method: quality MIME-TYPE (RANGES string)
Method: quality MIME-TYPE (RANGES list)

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

5.1.3 Classes

Class: media-range ()
Package

mimeparse

Source

mimeparse.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: type
Initargs

:type

Readers

media-type (generic function)

Slot: subtype
Initargs

:subtype

Readers

media-subtype (generic function)

Slot: params
Initargs

:params

Readers

media-params (generic function)

Writers

(setf media-params) (generic function)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: fitness-and-quality-parsed MIME-TYPE PARSED-RANGES

Find the best match for MIME-TYPE against PARSED-RANGES, which is a list of media-ranges that have already been parsed as if by PARSE-MEDIA-RANGE. Returns two values: the fitness value and the value of the ‘q’ quality parameter of the best match. -1 and 0 are returned if no match was found.

Package

mimeparse

Source

mimeparse.lisp (file)

Function: getparam P PARAMS
Package

mimeparse

Source

mimeparse.lisp (file)

Function: split-accept-header HEADER
Package

mimeparse

Source

mimeparse.lisp (file)

Function: strip STRING
Package

mimeparse

Source

mimeparse.lisp (file)


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

5.2.2 Generic functions

Generic Function: media-params OBJECT
Generic Function: (setf media-params) NEW-VALUE OBJECT
Package

mimeparse

Methods
Method: media-params (MEDIA-RANGE media-range)

automatically generated reader method

Source

mimeparse.lisp (file)

Method: (setf media-params) NEW-VALUE (MEDIA-RANGE media-range)

automatically generated writer method

Source

mimeparse.lisp (file)

Generic Function: media-subtype OBJECT
Package

mimeparse

Methods
Method: media-subtype (MEDIA-RANGE media-range)

automatically generated reader method

Source

mimeparse.lisp (file)

Generic Function: media-type OBJECT
Package

mimeparse

Methods
Method: media-type (MEDIA-RANGE media-range)

automatically generated reader method

Source

mimeparse.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-mimeparse.asd: The cl-mimeparse․asd file
cl-mimeparse/mimeparse.lisp: The cl-mimeparse/mimeparse․lisp file
cl-mimeparse/package.lisp: The cl-mimeparse/package․lisp file

F
File, Lisp, cl-mimeparse.asd: The cl-mimeparse․asd file
File, Lisp, cl-mimeparse/mimeparse.lisp: The cl-mimeparse/mimeparse․lisp file
File, Lisp, cl-mimeparse/package.lisp: The cl-mimeparse/package․lisp file

L
Lisp File, cl-mimeparse.asd: The cl-mimeparse․asd file
Lisp File, cl-mimeparse/mimeparse.lisp: The cl-mimeparse/mimeparse․lisp file
Lisp File, cl-mimeparse/package.lisp: The cl-mimeparse/package․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   (  
B   F   G   M   P   Q   S  
Index Entry  Section

(
(setf media-params): Internal generic functions
(setf media-params): Internal generic functions

B
best-match: Exported functions

F
fitness-and-quality-parsed: Internal functions
Function, best-match: Exported functions
Function, fitness-and-quality-parsed: Internal functions
Function, getparam: Internal functions
Function, parse-media-range: Exported functions
Function, split-accept-header: Internal functions
Function, strip: Internal functions

G
Generic Function, (setf media-params): Internal generic functions
Generic Function, media-params: Internal generic functions
Generic Function, media-subtype: Internal generic functions
Generic Function, media-type: Internal generic functions
Generic Function, quality: Exported generic functions
getparam: Internal functions

M
media-params: Internal generic functions
media-params: Internal generic functions
media-subtype: Internal generic functions
media-subtype: Internal generic functions
media-type: Internal generic functions
media-type: Internal generic functions
Method, (setf media-params): Internal generic functions
Method, media-params: Internal generic functions
Method, media-subtype: Internal generic functions
Method, media-type: Internal generic functions
Method, quality: Exported generic functions
Method, quality: Exported generic functions

P
parse-media-range: Exported functions

Q
quality: Exported generic functions
quality: Exported generic functions
quality: Exported generic functions

S
split-accept-header: Internal functions
strip: Internal functions

Jump to:   (  
B   F   G   M   P   Q   S  

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

A.3 Variables

Jump to:   P   S   T  
Index Entry  Section

P
params: Exported classes

S
Slot, params: Exported classes
Slot, subtype: Exported classes
Slot, type: Exported classes
subtype: Exported classes

T
type: Exported classes

Jump to:   P   S   T  

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

A.4 Data types

Jump to:   C   M   P   S  
Index Entry  Section

C
cl-mimeparse: The cl-mimeparse system
Class, media-range: Exported classes

M
media-range: Exported classes
mimeparse: The mimeparse package

P
Package, mimeparse: The mimeparse package

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

Jump to:   C   M   P   S