The local-time-duration Reference Manual

Table of Contents

The local-time-duration Reference Manual

This is the local-time-duration Reference Manual, version 1.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:12:32 2018 GMT+0.

1 Systems

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

1.1 local-time-duration

Author

WebCheckout, Inc.

License

MIT

Description

local-time-duration: Simple duration functionality on top of local-time

Version

1.1

Dependencies

• local-time
• alexandria
• esrap

Source

local-time-duration.asd (file)

Components

• package.lisp (file)
• defcomparator.lisp (file)
• duration.lisp (file)
• format.lisp (file)
• timestamp.lisp (file)
• iso8601.lisp (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 local-time-duration.asd

Location

local-time-duration.asd

Systems

local-time-duration (system)

Packages

local-time-duration-system

2.1.2 local-time-duration/package.lisp

Parent

local-time-duration (system)

Location

package.lisp

Packages

local-time-duration

2.1.3 local-time-duration/defcomparator.lisp

Dependency

package.lisp (file)

Parent

local-time-duration (system)

Location

defcomparator.lisp

Internal Definitions

%defcomparator (macro)

2.1.4 local-time-duration/duration.lisp

Dependency

defcomparator.lisp (file)

Parent

local-time-duration (system)

Location

duration.lisp

Exported Definitions

• duration (function)
• duration (class)
• duration* (function)
• duration+ (function)
• duration- (function)
• duration-as (function)
• duration-maximum (function)
• duration-minimum (function)
• duration/ (function)
• duration/= (compiler macro)
• duration/= (function)
• duration< (compiler macro)
• duration< (function)
• duration<= (compiler macro)
• duration<= (function)
• duration= (compiler macro)
• duration= (function)
• duration> (compiler macro)
• duration> (function)
• duration>= (compiler macro)
• duration>= (function)

Internal Definitions

• %duration-compare (function)
• %duration/= (function)
• %duration< (function)
• %duration<= (function)
• %duration= (function)
• %duration> (function)
• %duration>= (function)
• +nsecs-per-day+ (constant)
• +nsecs-per-hour+ (constant)
• +nsecs-per-minute+ (constant)
• +nsecs-per-second+ (constant)
• +nsecs-per-week+ (constant)
• day-of (method)
• (setf day-of) (method)
• decode-duration (function)
• nsec-of (method)
• (setf nsec-of) (method)
• sec-of (method)
• (setf sec-of) (method)

2.1.5 local-time-duration/format.lisp

Dependency

duration.lisp (file)

Parent

local-time-duration (system)

Location

format.lisp

Exported Definitions

human-readable-duration (function)

Internal Definitions

• call-with-designated-stream (function)
• pretty-seconds (function)
• with-designated-stream (macro)

2.1.6 local-time-duration/timestamp.lisp

Dependency

format.lisp (file)

Parent

local-time-duration (system)

Location

timestamp.lisp

Exported Definitions

• timestamp-difference (function)
• timestamp-duration+ (function)
• timestamp-duration- (function)

2.1.7 local-time-duration/iso8601.lisp

Dependency

timestamp.lisp (file)

Parent

local-time-duration (system)

Location

iso8601.lisp

Exported Definitions

parse-iso8601-duration (function)

Internal Definitions

• char-string-to-integer (function)
• format-iso8601-duration (function)
• make-duration-from-time-values (function)
• production-hms-to-list (function)
• production-ymd-to-list (function)

3 Packages

Packages are listed by definition order.

3.1 local-time-duration-system

Source

local-time-duration.asd

Use List

• common-lisp
• asdf/interface

3.2 local-time-duration

Source

package.lisp (file)

Nickname

ltd

Use List

• esrap
• common-lisp

Exported Definitions

• duration (function)
• duration (class)
• duration* (function)
• duration+ (function)
• duration- (function)
• duration-as (function)
• duration-maximum (function)
• duration-minimum (function)
• duration/ (function)
• duration/= (compiler macro)
• duration/= (function)
• duration< (compiler macro)
• duration< (function)
• duration<= (compiler macro)
• duration<= (function)
• duration= (compiler macro)
• duration= (function)
• duration> (compiler macro)
• duration> (function)
• duration>= (compiler macro)
• duration>= (function)
• human-readable-duration (function)
• parse-iso8601-duration (function)
• timestamp-difference (function)
• timestamp-duration+ (function)
• timestamp-duration- (function)

Internal Definitions

• %defcomparator (macro)
• %duration-compare (function)
• %duration/= (function)
• %duration< (function)
• %duration<= (function)
• %duration= (function)
• %duration> (function)
• %duration>= (function)
• +nsecs-per-day+ (constant)
• +nsecs-per-hour+ (constant)
• +nsecs-per-minute+ (constant)
• +nsecs-per-second+ (constant)
• +nsecs-per-week+ (constant)
• call-with-designated-stream (function)
• char-string-to-integer (function)
• day-of (generic function)
• day-of (method)
• (setf day-of) (method)
• (setf day-of) (generic function)
• decode-duration (function)
• format-iso8601-duration (function)
• make-duration-from-time-values (function)
• nsec-of (generic function)
• nsec-of (method)
• (setf nsec-of) (method)
• (setf nsec-of) (generic function)
• pretty-seconds (function)
• production-hms-to-list (function)
• production-ymd-to-list (function)
• sec-of (generic function)
• sec-of (method)
• (setf sec-of) (method)
• (setf sec-of) (generic function)
• with-designated-stream (macro)

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

4.1 Exported definitions

4.1.1 Compiler macros

Compiler Macro: duration/= &rest ITEMS

Package

local-time-duration

Source

duration.lisp (file)

Compiler Macro: duration< &rest ITEMS

Package

local-time-duration

Source

duration.lisp (file)

Compiler Macro: duration<= &rest ITEMS

Package

local-time-duration

Source

duration.lisp (file)

Compiler Macro: duration= &rest ITEMS

Package

local-time-duration

Source

duration.lisp (file)

Compiler Macro: duration> &rest ITEMS

Package

local-time-duration

Source

duration.lisp (file)

Compiler Macro: duration>= &rest ITEMS

Package

local-time-duration

Source

duration.lisp (file)

4.1.2 Functions

Function: duration &key WEEK DAY HOUR MINUTE SEC NSEC

Returns a new duration instance representing the sum of the ‘WEEK‘, ‘DAY‘, ‘HOUR‘, ‘MINUTE‘, ‘SEC‘, and ‘NSEC‘ arguments. Durations are normalized, that is, (duration :hour 1) and (duration :minute 60) will result in duration instances with the same internal representation.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration* DURATION FACTOR

Returns a fresh duration as long as ‘DURATION‘ multiplied by ‘FACTOR‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration+ &rest DURATIONS

Returns a fresh duration representing the sum of the lengths of its arguments.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration- &rest DURATIONS

Returns a fresh duration representing the result of subtracting the length of each argument in turn.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration-as DURATION UNIT

Returns two values: the first is the number of whole ‘UNIT‘s within ‘DURATION‘, and the second is a fresh duration representing the reamainder of the original duration after dividing it by ‘UNIT‘. ‘UNIT‘ must be one of :week, :day, :hour, :minute, :sec, and :nsec.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration-maximum DURATION &rest DURATIONS

Package

local-time-duration

Source

duration.lisp (file)

Function: duration-minimum DURATION &rest DURATIONS

Package

local-time-duration

Source

duration.lisp (file)

Function: duration/ DURATION DIVISOR

Returns a fresh duration that is as long as ‘DURATION‘ divided by ‘DIVISOR‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration/= &rest ITEMS

Returns ‘T‘ if every duration is not equally long, else returns ‘NIL‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration< &rest ITEMS

Returns ‘T‘ if every duration is shorter than the preceding duration, else returns ‘NIL‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration<= &rest ITEMS

Returns ‘T‘ if every duration is shorter than or equal to the preceding duration, else returns ‘NIL‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration= &rest ITEMS

Returns ‘T‘ if every duration is equally long, else returns ‘NIL‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration> &rest ITEMS

Returns ‘T‘ if every duration is longer than the preceding duration, else returns ‘NIL‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: duration>= &rest ITEMS

Returns ‘T‘ if every duration is longer than or equal to the preceding duration, else returns ‘NIL‘.

Package

local-time-duration

Source

duration.lisp (file)

Function: human-readable-duration DURATION &optional STREAM

Package

local-time-duration

Source

format.lisp (file)

Function: parse-iso8601-duration STRING

Parser for ISO8601 durations (with limitations) returning DURATION instances.

http://en.wikipedia.org/wiki/ISO_8601#Durations

The only, known, divergence from the syntax specified is that
fractional values are allowed anywhere and not only in the smallest value.

Package

local-time-duration

Source

iso8601.lisp (file)

Function: timestamp-difference TIME-A TIME-B

Returns a duration representing the time elapsed between the timestamps ‘TIME-A‘ and ‘TIME-B‘. This duration may be negative if ‘TIME-B‘ is later than ‘TIME-A‘.

Package

local-time-duration

Source

timestamp.lisp (file)

Function: timestamp-duration+ TIMESTAMP DURATION

Returns a fresh timestamp representing the time when ‘DURATION‘ has elapsed after ‘TIMESTAMP‘.

Package

local-time-duration

Source

timestamp.lisp (file)

Function: timestamp-duration- TIMESTAMP DURATION

Returns a fresh timestamp representing the time when ‘DURATION‘ will elapse before ‘TIMESTAMP‘.

Package

local-time-duration

Source

timestamp.lisp (file)

4.1.3 Classes

Class: duration ()

A duration instance represents a period of time with no additional context (e.g., starting or ending time or location).

Package

local-time-duration

Source

duration.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• nsec-of (method)
• nsec-of (method)
• sec-of (method)
• sec-of (method)
• day-of (method)
• day-of (method)

Direct slots

Slot: day

Type

integer

Initargs

:day

Initform

0

Readers

day-of (generic function)

Writers

(setf day-of) (generic function)

Slot: sec

Type

integer

Initargs

:sec

Initform

0

Readers

sec-of (generic function)

Writers

(setf sec-of) (generic function)

Slot: nsec

Type

integer

Initargs

:nsec

Initform

0

Readers

nsec-of (generic function)

Writers

(setf nsec-of) (generic function)

4.2 Internal definitions

4.2.1 Constants

Constant: +nsecs-per-day+

Package

local-time-duration

Source

duration.lisp (file)

Constant: +nsecs-per-hour+

Package

local-time-duration

Source

duration.lisp (file)

Constant: +nsecs-per-minute+

Package

local-time-duration

Source

duration.lisp (file)

Constant: +nsecs-per-second+

Package

local-time-duration

Source

duration.lisp (file)

Constant: +nsecs-per-week+

Package

local-time-duration

Source

duration.lisp (file)

4.2.2 Macros

Macro: %defcomparator NAME (TYPE) &body BODY

Package

local-time-duration

Source

defcomparator.lisp (file)

Macro: with-designated-stream (VAR STREAM) &body BODY

Binds VAR to the stream designated (as per cl:format’s stream argument) by the value STREAM and executes BODY.

If STREAM is nil VAR will be bound to a string-output-stream and the resulting string will be returned, otherwise the actual stream object used will be returned. In either case the return value of BODY is ignored.

Package

local-time-duration

Source

format.lisp (file)

4.2.3 Functions

Function: %duration-compare A B

Package

local-time-duration

Source

duration.lisp (file)

Function: %duration/= A B

Package

local-time-duration

Source

duration.lisp (file)

Function: %duration< A B

Package

local-time-duration

Source

duration.lisp (file)

Function: %duration<= A B

Package

local-time-duration

Source

duration.lisp (file)

Function: %duration= A B

Package

local-time-duration

Source

duration.lisp (file)

Function: %duration> A B

Package

local-time-duration

Source

duration.lisp (file)

Function: %duration>= A B

Package

local-time-duration

Source

duration.lisp (file)

Function: call-with-designated-stream STREAM THUNK

Package

local-time-duration

Source

format.lisp (file)

Function: char-string-to-integer CHARS

Package

local-time-duration

Source

iso8601.lisp (file)

Function: decode-duration DURATION &key WEEKS

Returns, as multiple values, DURATION’s logical components:

(nsecs secs minutes hours days weeks months years)

If WEEKS is T days the days component of DURATION will first be used to compute an integral number of weeks, and the remainder days will be returned. If WEEKS is NIL (the default) the weeks value will always be 0 and the whole number of days will be returned as DAYS.

In the current implementation MONTHS and YEARS are always 0.

Package

local-time-duration

Source

duration.lisp (file)

Function: format-iso8601-duration DESTINATION DURATION

Package

local-time-duration

Source

iso8601.lisp (file)

Function: make-duration-from-time-values VALUES

Package

local-time-duration

Source

iso8601.lisp (file)

Function: pretty-seconds SECS NSECS

Package

local-time-duration

Source

format.lisp (file)

Function: production-hms-to-list HOUR MINUTE SECOND

Package

local-time-duration

Source

iso8601.lisp (file)

Function: production-ymd-to-list YEAR MONTH DAY

Package

local-time-duration

Source

iso8601.lisp (file)

4.2.4 Generic functions

Generic Function: day-of OBJECT

Generic Function: (setf day-of) NEW-VALUE OBJECT

Package

local-time-duration

Methods

Method: day-of (DURATION duration)

automatically generated reader method

Source

duration.lisp (file)

Method: (setf day-of) NEW-VALUE (DURATION duration)

automatically generated writer method

Source

duration.lisp (file)

Generic Function: nsec-of OBJECT

Generic Function: (setf nsec-of) NEW-VALUE OBJECT

Package

local-time-duration

Methods

Method: nsec-of (DURATION duration)

automatically generated reader method

Source

duration.lisp (file)

Method: (setf nsec-of) NEW-VALUE (DURATION duration)

automatically generated writer method

Source

duration.lisp (file)

Generic Function: sec-of OBJECT

Generic Function: (setf sec-of) NEW-VALUE OBJECT

Package

local-time-duration

Methods

Method: sec-of (DURATION duration)

automatically generated reader method

Source

duration.lisp (file)

Method: (setf sec-of) NEW-VALUE (DURATION duration)

automatically generated writer method

Source

duration.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types