This is the local-time Reference Manual, version 1.0.6, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:10:57 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
local-timeA library for manipulating dates and times, based on a paper by Erik Naggum
Daniel Lowe <dlowe@dlowe.net>
BSD
1.0.6
uiop (system).
src (module).
Modules are listed depth-first from the system components tree.
local-time/srclocal-time (system).
package.lisp (file).
local-time.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
local-time/src/local-time.lisppackage.lisp (file).
src (module).
*clock* (special variable).
*default-timezone* (special variable).
+asctime-format+ (special variable).
+day-names+ (special variable).
+days-per-week+ (constant).
+gmt-zone+ (special variable).
+hours-per-day+ (constant).
+iso-8601-date-format+ (special variable).
+iso-8601-format+ (special variable).
+iso-8601-time-format+ (special variable).
+iso-week-date-format+ (special variable).
+minutes-per-day+ (constant).
+minutes-per-hour+ (constant).
+month-names+ (special variable).
+months-per-year+ (constant).
+rfc-1123-format+ (special variable).
+rfc3339-format+ (special variable).
+rfc3339-format/date-only+ (special variable).
+seconds-per-day+ (constant).
+seconds-per-hour+ (constant).
+seconds-per-minute+ (constant).
+short-day-names+ (special variable).
+short-month-names+ (special variable).
+utc-zone+ (special variable).
adjust-timestamp (macro).
adjust-timestamp! (macro).
all-timezones-matching-subzone (function).
astronomical-julian-date (function).
clock-now (generic function).
clock-today (generic function).
clone-timestamp (function).
date (type).
day-of (reader method).
(setf day-of) (writer method).
days-in-month (function).
decode-timestamp (function).
decode-universal-time-with-tz (function).
define-timezone (macro).
enable-read-macros (function).
encode-timestamp (function).
encode-universal-time-with-tz (function).
find-timezone-by-location-name (function).
format-rfc1123-timestring (function).
format-rfc3339-timestring (function).
format-timestring (function).
invalid-timestring (condition).
make-load-form (method).
make-timestamp (macro).
modified-julian-date (function).
now (function).
nsec-of (reader method).
(setf nsec-of) (writer method).
parse-rfc3339-timestring (function).
parse-timestring (function).
print-object (method).
print-object (method).
reread-timezone-repository (function).
sec-of (reader method).
(setf sec-of) (writer method).
time-of-day (type).
timestamp (class).
timestamp+ (function).
timestamp- (function).
timestamp-century (function).
timestamp-day (function).
timestamp-day-of-week (function).
timestamp-decade (function).
timestamp-difference (function).
timestamp-hour (function).
timestamp-maximize-part (function).
timestamp-maximum (function).
timestamp-microsecond (function).
timestamp-millennium (function).
timestamp-millisecond (function).
timestamp-minimize-part (function).
timestamp-minimum (function).
timestamp-minute (function).
timestamp-month (function).
timestamp-second (function).
timestamp-subtimezone (function).
timestamp-to-universal (function).
timestamp-to-unix (function).
timestamp-whole-year-difference (function).
timestamp-year (function).
timestamp/= (function).
timestamp< (compiler macro).
timestamp< (function).
timestamp<= (compiler macro).
timestamp<= (function).
timestamp= (compiler macro).
timestamp= (function).
timestamp> (compiler macro).
timestamp> (function).
timestamp>= (compiler macro).
timestamp>= (function).
timezones-matching-subzone (function).
to-rfc1123-timestring (function).
to-rfc3339-timestring (function).
today (function).
universal-to-timestamp (function).
unix-to-timestamp (function).
with-decoded-timestamp (macro).
zone-name (function).
%adjust-sec-for-leap-seconds (function).
%adjust-to-offset (function).
%adjust-to-timezone (function).
%construct-timestring (function).
%defcomparator (macro).
%expand-adjust-timestamp (function).
%expand-adjust-timestamp-changes (function).
%find-first-std-offset (function).
%fix-overflow-in-days (function).
%get-current-time (function).
%leap-seconds-offset (function).
%list-length= (function).
%make-simple-timezone (function).
%normalize-month-year-pair (function).
%offset-timestamp-part (function).
%read-binary-integer (function).
%read-timestring (function).
%read-universal-time (function).
%realize-timezone (function).
%set-timestamp-part (function).
%split-timestring (function).
%string-from-unsigned-byte-vector (function).
%subzone-as-of (function).
%timestamp-compare (function).
%timestamp-decode-date (function).
%timestamp-decode-iso-week (function).
%timestamp-decode-time (function).
%timestamp< (function).
%timestamp<= (function).
%timestamp= (function).
%timestamp> (function).
%timestamp>= (function).
%ts-day-of-week (function).
%tz-make-subzones (function).
%tz-read-abbrevs (function).
%tz-read-header (function).
%tz-read-indexes (function).
%tz-read-indicators (function).
%tz-read-leap-seconds (function).
%tz-read-subzone (function).
%tz-read-transitions (function).
%tz-verify-magic-number (function).
%valid-date? (function).
%valid-time-of-day? (function).
*abbreviated-subzone-name->timezone-list* (special variable).
*debug-timestamp* (special variable).
*default-timezone-repository-path* (special variable).
*location-name->timezone* (special variable).
*strict-first-subzone-validity* (special variable).
+astronomical-julian-date-offset+ (special variable).
+day-names-as-keywords+ (special variable).
+minimal-day-names+ (special variable).
+modified-julian-date-offset+ (special variable).
+none-zone+ (special variable).
+rotated-month-days-without-leap-day+ (special variable).
+rotated-month-offsets-without-leap-day+ (special variable).
+timezone-offset-max+ (constant).
+timezone-offset-min+ (constant).
+usecs-per-day+ (constant).
contest (function).
copy-subzone (function).
copy-timezone (function).
days-to-years (function).
decode-sec-day (function).
encode-offset (function).
encode-sec-day (function).
encode-timestamp-into-values (function).
failure-of (reader method).
(setf failure-of) (writer method).
invalid-time-specification (condition).
invalid-timezone-file (condition).
leap-seconds-adjustment (function).
leap-seconds-sec (function).
make-subzone (function).
make-timezone (function).
ordinalize (function).
package-with-symbol? (function).
path-of (reader method).
(setf path-of) (writer method).
sec-day-subtimezone (function).
split-timestring (function).
subzone (structure).
subzone-abbrev (reader).
(setf subzone-abbrev) (writer).
subzone-daylight-p (reader).
(setf subzone-daylight-p) (writer).
subzone-offset (reader).
(setf subzone-offset) (writer).
subzone-p (function).
timestamp-values-to-unix (function).
timestring-of (reader method).
(setf timestring-of) (writer method).
timezone (structure).
timezone-indexes (reader).
(setf timezone-indexes) (writer).
timezone-leap-seconds (reader).
(setf timezone-leap-seconds) (writer).
timezone-loaded (reader).
(setf timezone-loaded) (writer).
timezone-name (reader).
(setf timezone-name) (writer).
timezone-offset (type).
timezone-p (function).
timezone-path (reader).
(setf timezone-path) (writer).
timezone-subzones (reader).
(setf timezone-subzones) (writer).
timezone-transitions (reader).
(setf timezone-transitions) (writer).
timezone= (function).
transition-position (function).
ts-sec-day-to-universal (function).
universal-sec-day (function).
valid-timestamp-p (function).
years-to-days (function).
Packages are listed by definition order.
local-timecommon-lisp.
*clock* (special variable).
*default-timezone* (special variable).
+asctime-format+ (special variable).
+day-names+ (special variable).
+days-per-week+ (constant).
+gmt-zone+ (special variable).
+hours-per-day+ (constant).
+iso-8601-date-format+ (special variable).
+iso-8601-format+ (special variable).
+iso-8601-time-format+ (special variable).
+iso-week-date-format+ (special variable).
+minutes-per-day+ (constant).
+minutes-per-hour+ (constant).
+month-names+ (special variable).
+months-per-year+ (constant).
+rfc-1123-format+ (special variable).
+rfc3339-format+ (special variable).
+rfc3339-format/date-only+ (special variable).
+seconds-per-day+ (constant).
+seconds-per-hour+ (constant).
+seconds-per-minute+ (constant).
+short-day-names+ (special variable).
+short-month-names+ (special variable).
+utc-zone+ (special variable).
adjust-timestamp (macro).
adjust-timestamp! (macro).
all-timezones-matching-subzone (function).
astronomical-julian-date (function).
clock-now (generic function).
clock-today (generic function).
clone-timestamp (function).
date (type).
day-of (generic reader).
(setf day-of) (generic writer).
days-in-month (function).
decode-timestamp (function).
decode-universal-time-with-tz (function).
define-timezone (macro).
enable-read-macros (function).
encode-timestamp (function).
encode-universal-time-with-tz (function).
find-timezone-by-location-name (function).
format-rfc1123-timestring (function).
format-rfc3339-timestring (function).
format-timestring (function).
invalid-timestring (condition).
make-timestamp (macro).
modified-julian-date (function).
now (function).
nsec-of (generic reader).
(setf nsec-of) (generic writer).
parse-rfc3339-timestring (function).
parse-timestring (function).
reread-timezone-repository (function).
sec-of (generic reader).
(setf sec-of) (generic writer).
time-of-day (type).
timestamp (class).
timestamp+ (function).
timestamp- (function).
timestamp-century (function).
timestamp-day (function).
timestamp-day-of-week (function).
timestamp-decade (function).
timestamp-difference (function).
timestamp-hour (function).
timestamp-maximize-part (function).
timestamp-maximum (function).
timestamp-microsecond (function).
timestamp-millennium (function).
timestamp-millisecond (function).
timestamp-minimize-part (function).
timestamp-minimum (function).
timestamp-minute (function).
timestamp-month (function).
timestamp-second (function).
timestamp-subtimezone (function).
timestamp-to-universal (function).
timestamp-to-unix (function).
timestamp-whole-year-difference (function).
timestamp-year (function).
timestamp/= (function).
timestamp< (compiler macro).
timestamp< (function).
timestamp<= (compiler macro).
timestamp<= (function).
timestamp= (compiler macro).
timestamp= (function).
timestamp> (compiler macro).
timestamp> (function).
timestamp>= (compiler macro).
timestamp>= (function).
timezones-matching-subzone (function).
to-rfc1123-timestring (function).
to-rfc3339-timestring (function).
today (function).
universal-to-timestamp (function).
unix-to-timestamp (function).
with-decoded-timestamp (macro).
zone-name (function).
%adjust-sec-for-leap-seconds (function).
%adjust-to-offset (function).
%adjust-to-timezone (function).
%construct-timestring (function).
%defcomparator (macro).
%expand-adjust-timestamp (function).
%expand-adjust-timestamp-changes (function).
%find-first-std-offset (function).
%fix-overflow-in-days (function).
%get-current-time (function).
%leap-seconds-offset (function).
%list-length= (function).
%make-simple-timezone (function).
%normalize-month-year-pair (function).
%offset-timestamp-part (function).
%read-binary-integer (function).
%read-timestring (function).
%read-universal-time (function).
%realize-timezone (function).
%set-timestamp-part (function).
%split-timestring (function).
%string-from-unsigned-byte-vector (function).
%subzone-as-of (function).
%timestamp-compare (function).
%timestamp-decode-date (function).
%timestamp-decode-iso-week (function).
%timestamp-decode-time (function).
%timestamp< (function).
%timestamp<= (function).
%timestamp= (function).
%timestamp> (function).
%timestamp>= (function).
%ts-day-of-week (function).
%tz-make-subzones (function).
%tz-read-abbrevs (function).
%tz-read-header (function).
%tz-read-indexes (function).
%tz-read-indicators (function).
%tz-read-leap-seconds (function).
%tz-read-subzone (function).
%tz-read-transitions (function).
%tz-verify-magic-number (function).
%valid-date? (function).
%valid-time-of-day? (function).
*abbreviated-subzone-name->timezone-list* (special variable).
*debug-timestamp* (special variable).
*default-timezone-repository-path* (special variable).
*location-name->timezone* (special variable).
*strict-first-subzone-validity* (special variable).
+astronomical-julian-date-offset+ (special variable).
+day-names-as-keywords+ (special variable).
+minimal-day-names+ (special variable).
+modified-julian-date-offset+ (special variable).
+none-zone+ (special variable).
+rotated-month-days-without-leap-day+ (special variable).
+rotated-month-offsets-without-leap-day+ (special variable).
+timezone-offset-max+ (constant).
+timezone-offset-min+ (constant).
+usecs-per-day+ (constant).
contest (function).
copy-subzone (function).
copy-timezone (function).
days-to-years (function).
decode-sec-day (function).
encode-offset (function).
encode-sec-day (function).
encode-timestamp-into-values (function).
failure-of (generic reader).
(setf failure-of) (generic writer).
invalid-time-specification (condition).
invalid-timezone-file (condition).
leap-seconds-adjustment (function).
leap-seconds-sec (function).
make-subzone (function).
make-timezone (function).
ordinalize (function).
package-with-symbol? (function).
path-of (generic reader).
(setf path-of) (generic writer).
sec-day-subtimezone (function).
split-timestring (function).
subzone (structure).
subzone-abbrev (reader).
(setf subzone-abbrev) (writer).
subzone-daylight-p (reader).
(setf subzone-daylight-p) (writer).
subzone-offset (reader).
(setf subzone-offset) (writer).
subzone-p (function).
timestamp-values-to-unix (function).
timestring-of (generic reader).
(setf timestring-of) (generic writer).
timezone (structure).
timezone-indexes (reader).
(setf timezone-indexes) (writer).
timezone-leap-seconds (reader).
(setf timezone-leap-seconds) (writer).
timezone-loaded (reader).
(setf timezone-loaded) (writer).
timezone-name (reader).
(setf timezone-name) (writer).
timezone-offset (type).
timezone-p (function).
timezone-path (reader).
(setf timezone-path) (writer).
timezone-subzones (reader).
(setf timezone-subzones) (writer).
timezone-transitions (reader).
(setf timezone-transitions) (writer).
timezone= (function).
transition-position (function).
ts-sec-day-to-universal (function).
universal-sec-day (function).
valid-timestamp-p (function).
years-to-days (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Use the ‘*clock*’ special variable if you need to define your own idea of the current time.
The value of this variable should have at least a method ‘local-time::clock-now’; there may also be a ‘local-time::clock-today’ method, although the default based on ‘local-time::clock-now’ will probably do the job.
The currently supported values in local-time are:
t - use the standard clock
local-time:leap-second-adjusted - use a clock which adjusts for leap seconds using the information in *default-timezone*.
See the RFC 1123 for the details about the possible values of the timezone field.
Define zone-name (a symbol or a string) as a new timezone, lazy-loaded from zone-file (a pathname designator relative to the zoneinfo directory on this system. If load is true, load immediately.
This macro binds variables to the decoded elements of TIMESTAMP. The TIMEZONE argument is used for decoding the timestamp, and is not bound by the macro. The value of DAY-OF-WEEK starts from 0 which means Sunday.
Returns list of lists of timezone, matched subzone and last transition time
for timezones that have subzone matching specified ABBREVIATED-NAME. Includes both active and historical timezones.
Returns the astronomical julian date referred to by the timestamp.
Returns the number of days in the given month of the specified year.
Returns the decoded time as multiple values: nsec, ss, mm, hh, day, month, year, day-of-week
Like decode-universal-time, but with a timezone object instead of an timezone offset.
Differences with regard to decode-universal-time:
- the returned offset is the offset applicable in TIMEZONE at UNIVERSAL time,
and thus corrected for DST;
- returns one more value: the abbreviation of the active timezone.
Enables the local-time reader macros for literal timestamps and universal time.
Return a new TIMESTAMP instance corresponding to the specified time elements.
Like encode-universal-time, but with a timezone object instead of a timezone offset.
Formats a timestring in the RFC 3339 format, a restricted form of the ISO-8601 timestring specification for Internet timestamps.
Constructs a string representation of TIMESTAMP according
to FORMAT and returns it.
If destination is T, the string is written to *standard-output*.
If destination is a stream, the string is written to the stream.
FORMAT is a list containing one or more of strings, characters,
and keywords. Strings and characters are output literally,
while keywords are replaced by the values here:
:YEAR *year
:MONTH *numeric month
:DAY *day of month
:HOUR *hour
:MIN *minutes
:SEC *seconds
:WEEKDAY *numeric day of week starting from index 0, which means Sunday
:MSEC *milliseconds
:USEC *microseconds
:NSEC *nanoseconds
:ISO-WEEK-YEAR *year for ISO week date (can be different from regular calendar year)
:ISO-WEEK-NUMBER *ISO week number (i.e. 1 through 53)
:ISO-WEEK-DAY *ISO compatible weekday number (monday=1, sunday=7)
:LONG-WEEKDAY long form of weekday (e.g. Sunday, Monday)
:SHORT-WEEKDAY short form of weekday (e.g. Sun, Mon)
:MINIMAL-WEEKDAY minimal form of weekday (e.g. Su, Mo)
:SHORT-YEAR short form of year (last 2 digits, e.g. 41, 42 instead of 2041, 2042)
:LONG-MONTH long form of month (e.g. January, February)
:SHORT-MONTH short form of month (e.g. Jan, Feb)
:HOUR12 *hour on a 12-hour clock
:AMPM am/pm marker in lowercase
:GMT-OFFSET the gmt-offset of the time, in +00:00 form
:GMT-OFFSET-OR-Z like :GMT-OFFSET, but is Z when UTC
:GMT-OFFSET-HHMM like :GMT-OFFSET, but in +0000 form
:TIMEZONE timezone abbrevation for the time
Elements marked by * can be placed in a list in the form
(:keyword padding &optional (padchar #\0))
The string representation of the value will be padded with the padchar.
You can see examples in +ISO-8601-FORMAT+, +ASCTIME-FORMAT+, and +RFC-1123-FORMAT+.
Returns the modified julian date referred to by the timestamp.
Returns a timestamp representing the present moment.
Parse a timestring and return the corresponding TIMESTAMP. See split-timestring for details. Unspecified fields in the timestring are initialized to their lowest possible value, and timezone offset is 0 (UTC) unless explicitly specified in the input string.
Returns the ordinal century upon which the timestamp falls.
Returns the day of the month upon which the timestamp falls.
Returns the cardinal decade upon which the timestamp falls.
Returns the difference between TIME-A and TIME-B in seconds
Returns the latest timestamp
Returns the ordinal millennium upon which the timestamp falls.
Returns the earliest timestamp
Returns the month upon which the timestamp falls.
Return as multiple values the time zone as the number of seconds east of UTC, a boolean daylight-saving-p, and the customary abbreviation of the timezone.
Return the UNIVERSAL-TIME corresponding to the TIMESTAMP
Return the Unix time corresponding to the TIMESTAMP
Returns the number of whole years elapsed between time-a and time-b (hint: anniversaries).
Returns the cardinal year upon which the timestamp falls.
Returns T if no pair of timestamps is equal. Otherwise return NIL.
Returns list of lists of active timezone, matched subzone and last transition time
for timezones that have subzone matching specified ABBREVIATED-NAME as of TIMESTAMP moment if provided.
Returns a timestamp representing the present day.
Returns a timestamp corresponding to the given universal time.
Return a TIMESTAMP corresponding to UNIX, which is the number of seconds since the unix epoch, 1970-01-01T00:00:00Z.
Returns a timestamp for the current time given a clock.
Returns a timestamp for the current date given a
clock. The date is encoded by convention as a timestamp with the
time set to 00:00:00UTC.
timestamp) stream) ¶Print the TIMESTAMP object using the standard reader notation
timezone) stream) ¶Print the TIMEZONE object in a reader-rejected manner.
A hashtable of "CEST" -> list of timezones with "CEST" subzone
A hashtable with entries like "Europe/Budapest" -> timezone-instance
When true, raise an error if trying to get an offset before the first known transition.
Ajdust SEC from system time to Unix time (on systems those clock does not jump back over leap seconds).
Returns two values, the values of new DAY and SEC slots of the timestamp adjusted to the given timezone.
Constructs a string representing TIMESTAMP given the FORMAT
of the string and the TIMEZONE.
See the documentation of FORMAT-TIMESTRING for the structure of FORMAT.
In case the day number is higher than the maximal possible for the given month/year pair, returns the last day of the month.
Cross-implementation abstraction to get the current time measured from the unix epoch (1/1/1970). Should return (values sec nano-sec).
Find the latest leap second adjustment effective at SEC system time.
Tests for a list of length NUM without traversing the entire list to get the length.
Normalizes the month/year pair: in case month is < 1 or > 12 the month and year are corrected to handle the overflow.
Returns a time adjusted by the specified OFFSET. Takes care of different kinds of overflows. The setting :day-of-week is possible using a keyword symbol name of a week-day (see +DAY-NAMES-AS-KEYWORDS+) as value. In that case point the result to day given by OFFSET in the week that contains TIME.
Read BYTE-COUNT bytes from the binary stream STREAM, and return an integer which is its representation in network byte order (MSB). If SIGNED is true, interprets the most significant bit as a sign indicator.
If timezone has not already been loaded or RELOAD is non-NIL, loads the timezone information from its associated unix file. If the file is not a valid timezone file, the condition INVALID-TIMEZONE-FILE will be signaled.
Based on http://www.ietf.org/rfc/rfc3339.txt including the function names used. Returns (values year month day hour minute second nsec offset-hour offset-minute). On parsing failure, signals INVALID-TIMESTRING if FAIL-ON-ERROR is NIL, otherwise returns NIL.
Returns a string created from the vector of unsigned bytes VECTOR starting at OFFSET which is terminated by a 0.
TIMEZONE is a realized timezone; SECONDS and DAYS are ’timestamp-values’
describing a local time, or null to ask for the subzone after the last
transition. Return the applicable subzone and the transition-index for that
subzone.
When GUESS-P is true, the request is about SECONDS and DAYS in a timezone
which may not be UTC, and therefore the unix-time derived from SECONDS and
DAYS has an offset with respect to UTC: the offset of the subzone to be
found.
Returns the symbols <, >, or =, describing the relationship between TIME-A and TIME-b.
Returns the year, month, and day, given the number of days from the epoch.
Returns the year, week number, and day of week components of an ISO week date.
Returns the hours, minutes, and seconds, given the number of seconds since midnight.
Applies TEST to pairs of elements in list, keeping the element which last tested T. Returns the winning element.
Given a number of days, returns the number of years and the remaining days in that year.
Returns (VALUES NSEC SEC DAY ZONE) ready to be used for instantiating a new timestamp object. If the specified time is invalid, the condition INVALID-TIME-SPECIFICATION is raised.
Return an ordinal string representing the position of DAY in a sequence (1st, 2nd, 3rd, 4th, etc).
Return the Unix time corresponding to the values used to encode a TIMESTAMP
name.
path.
Return two values indicating the relationship between timezone-1 and timezone-2. The first value is whether the two timezones are equal and the second value indicates whether it is sure or not.
In other words:
(values t t) means timezone-1 and timezone-2 are definitely equal.
(values nil t) means timezone-1 and timezone-2 are definitely different.
(values nil nil) means that it couldn’t be determined.
Return the UNIVERSAL-TIME corresponding to the TIMESTAMP
Returns T if the time values refer to a valid time, otherwise returns NIL.
Given a number of years, returns the number of days in those years.
invalid-timestring)) ¶invalid-timestring)) ¶invalid-timezone-file)) ¶invalid-timezone-file)) ¶path.
invalid-timestring)) ¶invalid-timestring)) ¶error.
error.
:path
structure-object.
simple-vector
#(0)
simple-vector
#(0)
simple-vector
#()
list
string
"anonymous"
boolean
| Jump to: | %
(
A C D E F G L M N O P R S T U V W Y Z |
|---|
| Jump to: | %
(
A C D E F G L M N O P R S T U V W Y Z |
|---|
| Jump to: | *
+
A C D F I L N O P S T |
|---|
| Jump to: | *
+
A C D F I L N O P S T |
|---|
| Jump to: | C D F I L M P S T |
|---|
| Jump to: | C D F I L M P S T |
|---|