The trivial-rfc-1123 Reference Manual

This is the trivial-rfc-1123 Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:34:12 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-rfc-1123

minimal parsing of rfc-1123 date-time strings

Author

Stacksmith <>

License

Edi Weitz and BSD 3-clause

Dependency

cl-ppcre (system).

Source

trivial-rfc-1123.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 trivial-rfc-1123/trivial-rfc-1123.asd

Source

trivial-rfc-1123.asd.

Parent Component

trivial-rfc-1123 (system).

ASDF Systems

trivial-rfc-1123.


3.1.2 trivial-rfc-1123/package.lisp

Source

trivial-rfc-1123.asd.

Parent Component

trivial-rfc-1123 (system).

Packages

trivial-rfc-1123.


3.1.3 trivial-rfc-1123/trivial-rfc-1123.lisp

Dependency

package.lisp (file).

Source

trivial-rfc-1123.asd.

Parent Component

trivial-rfc-1123 (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-rfc-1123

Source

package.lisp.

Nickname

t1123

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: as-rfc-1123 (universal-time &key stream timezone)

format a universal time to string (default) or optional stream, in GMT timezone (unless :timezone option is specified, in Lisp sign-inverted manner. Specifying NIL for timezone will insert machine-local current timezone, which only makes sense for dealing with current time!

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.

Function: parse-date (string)

Parses a date and returns it as a Lisp universal
time. Currently understands the following formats:

"Wed, 06-Feb-2008 21:01:38 GMT"
"Wed, 06-Feb-08 21:01:38 GMT"
"Tue Feb 13 08:00:00 2007 GMT"
"Wednesday, 07-February-2027 08:55:23 GMT"
"Wed, 07-02-2017 10:34:45 GMT"

Instead of "GMT" time zone abbreviations like "CEST" and UTC offsets like "GMT-01:30" are also allowed.

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *time-zone-map*

An alist which maps time zone abbreviations to Common Lisp timezones.

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.

Special Variable: +day-names+
Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.

Special Variable: +month-names+
Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.


5.2.2 Macros

Macro: when-letx ((var expr) &body body)

Evaluates EXPR, binds it to VAR, and executes BODY if VAR has a true value.

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.


5.2.3 Ordinary functions

Function: date-parse-error (format-control &rest format-arguments)

Signals an error of type DATE-PARSE-ERROR with the provided format control and arguments.

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.

Function: interpret-as-month (string)

Tries to interpret STRING as a string denoting a month and returns the corresponding number of the month. Accepts three-letter abbreviations like "Feb" and full month names likes "February". Finally, the function also accepts strings representing integers from one to twelve.

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.

Function: interpret-as-time-zone (string)

Tries to interpret STRING as a time zone abbreviation which can either be something like "PST" or "GMT" with an offset like "GMT-02:00".

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.

Function: safe-parse-integer (string)

Like PARSE-INTEGER, but returns NIL instead of signalling an error.

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.


5.2.4 Conditions

Condition: date-parse-error

Signaled when the date cannot be parsed.

Package

trivial-rfc-1123.

Source

trivial-rfc-1123.lisp.

Direct superclasses

error.


Appendix A Indexes


A.1 Concepts