The eclecticse.iso-8601-date Reference Manual

This is the eclecticse.iso-8601-date Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 18:26:35 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 eclecticse.iso-8601-date

Miscellaneous date routines based around ISO-8601 representation.

Author

David K. Trudgett

License

LLGPL

Version

1.0.0

Dependency

local-time (system).

Source

eclecticse.iso-8601-date.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 eclecticse.iso-8601-date/eclecticse.iso-8601-date.asd

Source

eclecticse.iso-8601-date.asd.

Parent Component

eclecticse.iso-8601-date (system).

ASDF Systems

eclecticse.iso-8601-date.


3.1.2 eclecticse.iso-8601-date/package.lisp

Source

eclecticse.iso-8601-date.asd.

Parent Component

eclecticse.iso-8601-date (system).

Packages

eclecticse.iso-8601-date.


3.1.3 eclecticse.iso-8601-date/iso-8601-date.lisp

Dependency

package.lisp (file).

Source

eclecticse.iso-8601-date.asd.

Parent Component

eclecticse.iso-8601-date (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 eclecticse.iso-8601-date

Source

package.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: d/m/y->iso-8601-date (dmy-date-string &key hyphen)

Convert a d/m/y date string into ISO 8601 string format. Returns NIL for invalid dates. Does not check leap years for the number of days in February.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: date-add (date days)

Add DAYS number of days to DATE.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: date-diff (date-1 date-2)

Return the number of days between DATE-1 and DATE-2.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: date-portion (iso-8601-date-time)

Return the date portion of an ISO 8601 date/time string. Assumes that the date string contains hyphen separators, and is therefore exactly ten characters long.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: extract-day (iso-8601-date)

Return the integer day of the month represented by the ISO-8601-DATE.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: extract-month (iso-8601-date)

Return the integer month represented by the ISO-8601-DATE.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: extract-year (iso-8601-date)

Return the integer year represented by the ISO-8601-DATE.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: human-date (date-string)

Strip the T from ISO8601 dates, and remove decimal portion of seconds, if any.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: iso-8601-date-now (&key hyphen)

Return a string representing the current date in ISO 8601 format.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: iso-8601-date-time-now (&key t-sep hyphen colon)

Return a string representing the current date and time in ISO 8601 format.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: iso-8601-time-now (&key colon)

Return a string representing the current time in ISO 8601 HH:mm:ss format.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: last-month ()

Return ISO 8601 year/month string for the month previous to the current month. Example: if current month is May 2020, return "2020-04".

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: make-iso-8601-date (year month day &key hyphen)

Given numerical values for the year, month and day, return a string representing the date in ISO 8601 format.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: num-day-of-week (date)

Return the numerical day of the week for DATE.
1 for Sunday, 2 or Monday, etc., up to 7 for Saturday.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *week-days*
Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.


5.2.2 Ordinary functions

Function: day-of-week (date)

Return the English day of the week name for the given DATE.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: four-digit-str (int)

Convert an integer in the range 0 to 9999 into a four-character string with leading zeroes, if necessary.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.

Function: two-digit-str (int)

Convert an integer in the range 0 to 99 into a two-character string with leading 0, if necessary.

Package

eclecticse.iso-8601-date.

Source

iso-8601-date.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   D   E   F   H   I   L   M   N   T  
Index Entry  Section

D
d/m/y->iso-8601-date: Public ordinary functions
date-add: Public ordinary functions
date-diff: Public ordinary functions
date-portion: Public ordinary functions
day-of-week: Private ordinary functions

E
extract-day: Public ordinary functions
extract-month: Public ordinary functions
extract-year: Public ordinary functions

F
four-digit-str: Private ordinary functions
Function, d/m/y->iso-8601-date: Public ordinary functions
Function, date-add: Public ordinary functions
Function, date-diff: Public ordinary functions
Function, date-portion: Public ordinary functions
Function, day-of-week: Private ordinary functions
Function, extract-day: Public ordinary functions
Function, extract-month: Public ordinary functions
Function, extract-year: Public ordinary functions
Function, four-digit-str: Private ordinary functions
Function, human-date: Public ordinary functions
Function, iso-8601-date-now: Public ordinary functions
Function, iso-8601-date-time-now: Public ordinary functions
Function, iso-8601-time-now: Public ordinary functions
Function, last-month: Public ordinary functions
Function, make-iso-8601-date: Public ordinary functions
Function, num-day-of-week: Public ordinary functions
Function, two-digit-str: Private ordinary functions

H
human-date: Public ordinary functions

I
iso-8601-date-now: Public ordinary functions
iso-8601-date-time-now: Public ordinary functions
iso-8601-time-now: Public ordinary functions

L
last-month: Public ordinary functions

M
make-iso-8601-date: Public ordinary functions

N
num-day-of-week: Public ordinary functions

T
two-digit-str: Private ordinary functions


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*week-days*: Private special variables

S
Special Variable, *week-days*: Private special variables