The simple-date-time Reference Manual
Table of Contents
The simple-date-time Reference Manual
This is the simple-date-time Reference Manual, version 0.1.0,
generated automatically by Declt version 2.4 "Will Decker"
on Wed Jun 20 12:34:35 2018 GMT+0.
1 Introduction
simple-date-time
date and time library for common lisp
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 simple-date-time
- Author
TAHARA Yoshinori <read.eval.print@gmail.com>
- License
BSD
- Description
date and time library for common lisp
- Version
0.1.0
- Dependency
cl-ppcre
- Source
simple-date-time.asd (file)
- Components
-
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 simple-date-time.asd
- Location
simple-date-time.asd
- Systems
simple-date-time (system)
3.1.2 simple-date-time/package.lisp
- Parent
simple-date-time (system)
- Location
package.lisp
- Packages
simple-date-time
3.1.3 simple-date-time/date-time.lisp
- Dependency
package.lisp (file)
- Parent
simple-date-time (system)
- Location
date-time.lisp
- Exported Definitions
-
- Internal Definitions
-
4 Packages
Packages are listed by definition order.
4.1 simple-date-time
- Source
package.lisp (file)
- Nicknames
-
- Use List
common-lisp
- Exported Definitions
-
- Internal Definitions
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Exported definitions
5.1.1 Special variables
- Special Variable: *default-timezone*
-
Default timezone. GMT is 0. JST is 9. EST is -5.
- Package
simple-date-time
- Source
date-time.lisp (file)
5.1.2 Functions
- Function: clone DATE-TIME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date-time/= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date-time< DT1 DT2
-
Compare two DATE-TIME objects for date1 < date2
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date-time<= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date-time= DT1 DT2
-
Compare two DATE-TIME objects for both date1 = date2 and time1 =
time2.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date-time> DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date-time>= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date/= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date< DT1 DT2
-
Compare two DATE-TIME objects for date1 < date2
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date<= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date= DT1 DT2
-
Compare two DATE-TIME objects for date1 = date2
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date> DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: date>= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: day+ DATE-TIME DELTA
-
Function adds X to DATE-TIME object slot without
normalizing.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: day-name-of DATE
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: day-of-week-of DATE-TIME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: deserialize MILLISECOND
-
Returns a normalized DATE-TIME object from input in milliseconds
from beginning of date-time (1 1 1 0:0:0).
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: from-posix-time TIME
-
Returns a DATE-TIME object from posix TIME
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: from-string STRING &key FORMAT TIMEZONE
-
Returns a DATE-TIME object set from parsing STRING.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: from-universal-time &optional UNIVERSAL-TIME MILLISECOND
-
Returns a DATE-TIME object set from UNIVERSAL-TIME (default is now)
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: hh:mm DATE-TIME
-
Write string for DATE-TIME object in format: hh:mm
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: hour+ DATE-TIME DELTA
-
Function adds X to DATE-TIME object slot without
normalizing.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: http-date DATE-TIME &optional TIMEZONE
-
Write string for HTTP-Date
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: make-date YEAR MONTH DAY
-
Constructs a DATE-TIME object from given date arguments.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: make-date-time YEAR MONTH DAY &optional HOUR MINUTE SECOND MILLISECOND
-
Constructs a DATE-TIME object from given date and optional time
arguments.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: make-time HOUR MINUTE SECOND &optional MILLISECOND
-
Constructs a DATE-TIME object from given time arguments.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: millisecond+ DATE-TIME DELTA
-
Function adds X to DATE-TIME object slot without
normalizing.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: minute+ DATE-TIME DELTA
-
Function adds X to DATE-TIME object slot without
normalizing.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: month+ DATE-TIME DELTA
-
Increments MONTH-OF DATE-TIME object by DELTA. Does not normalize
the result.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: month-name-of DATE
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: normalize DATE-TIME
-
Returns a DATE-TIME object with date slots adjusted to be within
normal bounds.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: now ()
-
Returns DATE-TIME object set to the current time.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: rfc-2822 DATE-TIME &optional TIMEZONE
-
Write string for DATE-TIME object as per rfc-2822 (including time
zone).
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: second+ DATE-TIME DELTA
-
Function adds X to DATE-TIME object slot without
normalizing.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: serialize DATE-TIME
-
Calculates integer milliseconds from DATE-TIME object beginning of
time (Jan 1 1 0:0:0)
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: time/= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: time< DT1 DT2
-
Compare two DATE-TIME objects for time1 < time2
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: time<= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: time= DT1 DT2
-
Compare two DATE-TIME objects for time1 = time2
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: time> DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: time>= DT1 DT2
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: to-universal-time DATE-TIME &optional TIMEZONE
-
Returns the universal time for DATE-TIME object (truncating
milliseconds).
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: today ()
-
Returns a DATE-TIME object set to the start of the current day.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: tomorrow ()
-
Returns a DATE-TIME object set to the start of the day following
the current day.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: week-of DATE-TIME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: year+ DATE-TIME DELTA
-
Increments YEAR-OF DATE-TIME object by DELTA. Does not normalize
the result.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yesterday ()
-
Returns a DATE-TIME object set to the start of the day before the
current day.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yy-mm-dd DATE-TIME
-
Write string for DATE-TIME object in format: yy-mm-dd
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yy.mm.dd DATE-TIME
-
Write string for DATE-TIME object in format: yy.mm.dd
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yy/mm/dd DATE-TIME
-
Write string for DATE-TIME object in format: yy/mm/dd
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyy-mm-dd DATE-TIME
-
Write string for DATE-TIME object in format: yyyy-mm-dd
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyy-mm-dd␣hh:mm DATE-TIME
-
Write string for DATE-TIME object in format: yyyy-mm-dd hh:mm
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyy-mm-dd␣hh:mm:ss DATE-TIME
-
Write string for DATE-TIME object in format: yyyy-mm-dd hh:mm:ss
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyy/mm/dd DATE-TIME
-
Write string for DATE-TIME object in format: yyyy/mm/dd
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyymmdd DATE-TIME
-
Write string for DATE-TIME object in format: yyyymmdd
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyymmddthhmmssz DATE-TIME
-
Write string for DATE-TIME object in format: YYYYMMDD’T’HHMMSS’Z’
- Package
simple-date-time
- Source
date-time.lisp (file)
5.1.3 Generic functions
- Generic Function: day-of OBJECT
-
- Package
simple-date-time
- Methods
- Method: day-of (DATE-TIME date-time)
-
automatically generated reader method
- Source
date-time.lisp (file)
- Generic Function: hour-of OBJECT
-
- Package
simple-date-time
- Methods
- Method: hour-of (DATE-TIME date-time)
-
automatically generated reader method
- Source
date-time.lisp (file)
- Generic Function: millisecond-of OBJECT
-
- Package
simple-date-time
- Methods
- Method: millisecond-of (DATE-TIME date-time)
-
automatically generated reader method
- Source
date-time.lisp (file)
- Generic Function: minute-of OBJECT
-
- Package
simple-date-time
- Methods
- Method: minute-of (DATE-TIME date-time)
-
automatically generated reader method
- Source
date-time.lisp (file)
- Generic Function: month-of OBJECT
-
- Package
simple-date-time
- Methods
- Method: month-of (DATE-TIME date-time)
-
automatically generated reader method
- Source
date-time.lisp (file)
- Generic Function: second-of OBJECT
-
- Package
simple-date-time
- Methods
- Method: second-of (DATE-TIME date-time)
-
automatically generated reader method
- Source
date-time.lisp (file)
- Generic Function: year-of OBJECT
-
- Package
simple-date-time
- Methods
- Method: year-of (DATE-TIME date-time)
-
automatically generated reader method
- Source
date-time.lisp (file)
5.1.4 Classes
- Class: date-time ()
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: year
-
- Initargs
:year
- Readers
year-of (generic function)
- Slot: month
-
- Initargs
:month
- Readers
month-of (generic function)
- Slot: day
-
- Initargs
:day
- Readers
day-of (generic function)
- Slot: hour
-
- Initargs
:hour
- Readers
hour-of (generic function)
- Slot: minute
-
- Initargs
:minute
- Readers
minute-of (generic function)
- Slot: second
-
- Initargs
:second
- Readers
second-of (generic function)
- Slot: millisecond
-
- Initargs
:millisecond
- Initform
0
- Readers
millisecond-of (generic function)
5.2 Internal definitions
5.2.1 Constants
- Constant: +posix-epoch+
-
- Package
simple-date-time
- Source
date-time.lisp (file)
5.2.2 Special variables
- Special Variable: *leap-year-days-of-month*
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Special Variable: *normal-year-days-of-month*
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Special Variable: *short-month-names*
-
- Package
simple-date-time
- Source
date-time.lisp (file)
5.2.3 Functions
- Function: days-of-month YEAR MONTH
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: days-of-year YEAR
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: ensure-last-day-of-month DATE-TIME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: from-short-month-name MONTH-NAME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: from-string-with-format STRING FORMAT
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: leap-year-p YEAR
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: normalize-date DATE-TIME
-
Returns a DATE-TIME object with date slots adjusted so they are all
within normal bounds.
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: normalize-time DATE-TIME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: serialize-date DATE-TIME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: serialize-time DATE-TIME
-
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyy/mm/dd␣hh:mm DATE-TIME
-
Write string for DATE-TIME object in format: yyyy/mm/dd hh:mm
- Package
simple-date-time
- Source
date-time.lisp (file)
- Function: yyyy/mm/dd␣hh:mm:ss DATE-TIME
-
Write string for DATE-TIME object in format: yyyy/mm/dd hh:mm:ss
- Package
simple-date-time
- Source
date-time.lisp (file)
Appendix A Indexes
A.1 Concepts
A.2 Functions
| Index Entry | | Section |
|
C | | |
| clone : | | Exported functions |
|
D | | |
| date-time/= : | | Exported functions |
| date-time< : | | Exported functions |
| date-time<= : | | Exported functions |
| date-time= : | | Exported functions |
| date-time> : | | Exported functions |
| date-time>= : | | Exported functions |
| date/= : | | Exported functions |
| date< : | | Exported functions |
| date<= : | | Exported functions |
| date= : | | Exported functions |
| date> : | | Exported functions |
| date>= : | | Exported functions |
| day+ : | | Exported functions |
| day-name-of : | | Exported functions |
| day-of : | | Exported generic functions |
| day-of : | | Exported generic functions |
| day-of-week-of : | | Exported functions |
| days-of-month : | | Internal functions |
| days-of-year : | | Internal functions |
| deserialize : | | Exported functions |
|
E | | |
| ensure-last-day-of-month : | | Internal functions |
|
F | | |
| from-posix-time : | | Exported functions |
| from-short-month-name : | | Internal functions |
| from-string : | | Exported functions |
| from-string-with-format : | | Internal functions |
| from-universal-time : | | Exported functions |
| Function, clone : | | Exported functions |
| Function, date-time/= : | | Exported functions |
| Function, date-time< : | | Exported functions |
| Function, date-time<= : | | Exported functions |
| Function, date-time= : | | Exported functions |
| Function, date-time> : | | Exported functions |
| Function, date-time>= : | | Exported functions |
| Function, date/= : | | Exported functions |
| Function, date< : | | Exported functions |
| Function, date<= : | | Exported functions |
| Function, date= : | | Exported functions |
| Function, date> : | | Exported functions |
| Function, date>= : | | Exported functions |
| Function, day+ : | | Exported functions |
| Function, day-name-of : | | Exported functions |
| Function, day-of-week-of : | | Exported functions |
| Function, days-of-month : | | Internal functions |
| Function, days-of-year : | | Internal functions |
| Function, deserialize : | | Exported functions |
| Function, ensure-last-day-of-month : | | Internal functions |
| Function, from-posix-time : | | Exported functions |
| Function, from-short-month-name : | | Internal functions |
| Function, from-string : | | Exported functions |
| Function, from-string-with-format : | | Internal functions |
| Function, from-universal-time : | | Exported functions |
| Function, hh:mm : | | Exported functions |
| Function, hour+ : | | Exported functions |
| Function, http-date : | | Exported functions |
| Function, leap-year-p : | | Internal functions |
| Function, make-date : | | Exported functions |
| Function, make-date-time : | | Exported functions |
| Function, make-time : | | Exported functions |
| Function, millisecond+ : | | Exported functions |
| Function, minute+ : | | Exported functions |
| Function, month+ : | | Exported functions |
| Function, month-name-of : | | Exported functions |
| Function, normalize : | | Exported functions |
| Function, normalize-date : | | Internal functions |
| Function, normalize-time : | | Internal functions |
| Function, now : | | Exported functions |
| Function, rfc-2822 : | | Exported functions |
| Function, second+ : | | Exported functions |
| Function, serialize : | | Exported functions |
| Function, serialize-date : | | Internal functions |
| Function, serialize-time : | | Internal functions |
| Function, time/= : | | Exported functions |
| Function, time< : | | Exported functions |
| Function, time<= : | | Exported functions |
| Function, time= : | | Exported functions |
| Function, time> : | | Exported functions |
| Function, time>= : | | Exported functions |
| Function, to-universal-time : | | Exported functions |
| Function, today : | | Exported functions |
| Function, tomorrow : | | Exported functions |
| Function, week-of : | | Exported functions |
| Function, year+ : | | Exported functions |
| Function, yesterday : | | Exported functions |
| Function, yy-mm-dd : | | Exported functions |
| Function, yy.mm.dd : | | Exported functions |
| Function, yy/mm/dd : | | Exported functions |
| Function, yyyy-mm-dd : | | Exported functions |
| Function, yyyy-mm-dd␣hh:mm : | | Exported functions |
| Function, yyyy-mm-dd␣hh:mm:ss : | | Exported functions |
| Function, yyyy/mm/dd : | | Exported functions |
| Function, yyyy/mm/dd␣hh:mm : | | Internal functions |
| Function, yyyy/mm/dd␣hh:mm:ss : | | Internal functions |
| Function, yyyymmdd : | | Exported functions |
| Function, yyyymmddthhmmssz : | | Exported functions |
|
G | | |
| Generic Function, day-of : | | Exported generic functions |
| Generic Function, hour-of : | | Exported generic functions |
| Generic Function, millisecond-of : | | Exported generic functions |
| Generic Function, minute-of : | | Exported generic functions |
| Generic Function, month-of : | | Exported generic functions |
| Generic Function, second-of : | | Exported generic functions |
| Generic Function, year-of : | | Exported generic functions |
|
H | | |
| hh:mm : | | Exported functions |
| hour+ : | | Exported functions |
| hour-of : | | Exported generic functions |
| hour-of : | | Exported generic functions |
| http-date : | | Exported functions |
|
L | | |
| leap-year-p : | | Internal functions |
|
M | | |
| make-date : | | Exported functions |
| make-date-time : | | Exported functions |
| make-time : | | Exported functions |
| Method, day-of : | | Exported generic functions |
| Method, hour-of : | | Exported generic functions |
| Method, millisecond-of : | | Exported generic functions |
| Method, minute-of : | | Exported generic functions |
| Method, month-of : | | Exported generic functions |
| Method, second-of : | | Exported generic functions |
| Method, year-of : | | Exported generic functions |
| millisecond+ : | | Exported functions |
| millisecond-of : | | Exported generic functions |
| millisecond-of : | | Exported generic functions |
| minute+ : | | Exported functions |
| minute-of : | | Exported generic functions |
| minute-of : | | Exported generic functions |
| month+ : | | Exported functions |
| month-name-of : | | Exported functions |
| month-of : | | Exported generic functions |
| month-of : | | Exported generic functions |
|
N | | |
| normalize : | | Exported functions |
| normalize-date : | | Internal functions |
| normalize-time : | | Internal functions |
| now : | | Exported functions |
|
R | | |
| rfc-2822 : | | Exported functions |
|
S | | |
| second+ : | | Exported functions |
| second-of : | | Exported generic functions |
| second-of : | | Exported generic functions |
| serialize : | | Exported functions |
| serialize-date : | | Internal functions |
| serialize-time : | | Internal functions |
|
T | | |
| time/= : | | Exported functions |
| time< : | | Exported functions |
| time<= : | | Exported functions |
| time= : | | Exported functions |
| time> : | | Exported functions |
| time>= : | | Exported functions |
| to-universal-time : | | Exported functions |
| today : | | Exported functions |
| tomorrow : | | Exported functions |
|
W | | |
| week-of : | | Exported functions |
|
Y | | |
| year+ : | | Exported functions |
| year-of : | | Exported generic functions |
| year-of : | | Exported generic functions |
| yesterday : | | Exported functions |
| yy-mm-dd : | | Exported functions |
| yy.mm.dd : | | Exported functions |
| yy/mm/dd : | | Exported functions |
| yyyy-mm-dd : | | Exported functions |
| yyyy-mm-dd␣hh:mm : | | Exported functions |
| yyyy-mm-dd␣hh:mm:ss : | | Exported functions |
| yyyy/mm/dd : | | Exported functions |
| yyyy/mm/dd␣hh:mm : | | Internal functions |
| yyyy/mm/dd␣hh:mm:ss : | | Internal functions |
| yyyymmdd : | | Exported functions |
| yyyymmddthhmmssz : | | Exported functions |
|
A.3 Variables
| Index Entry | | Section |
|
* | | |
| *default-timezone* : | | Exported special variables |
| *leap-year-days-of-month* : | | Internal special variables |
| *normal-year-days-of-month* : | | Internal special variables |
| *short-month-names* : | | Internal special variables |
|
+ | | |
| +posix-epoch+ : | | Internal constants |
|
C | | |
| Constant, +posix-epoch+ : | | Internal constants |
|
D | | |
| day : | | Exported classes |
|
H | | |
| hour : | | Exported classes |
|
M | | |
| millisecond : | | Exported classes |
| minute : | | Exported classes |
| month : | | Exported classes |
|
S | | |
| second : | | Exported classes |
| Slot, day : | | Exported classes |
| Slot, hour : | | Exported classes |
| Slot, millisecond : | | Exported classes |
| Slot, minute : | | Exported classes |
| Slot, month : | | Exported classes |
| Slot, second : | | Exported classes |
| Slot, year : | | Exported classes |
| Special Variable, *default-timezone* : | | Exported special variables |
| Special Variable, *leap-year-days-of-month* : | | Internal special variables |
| Special Variable, *normal-year-days-of-month* : | | Internal special variables |
| Special Variable, *short-month-names* : | | Internal special variables |
|
Y | | |
| year : | | Exported classes |
|
A.4 Data types