Logo

Package Enums

The following Enums are used throughout the package.

Temporal Concept

Unit

The Unit enum defines all time units supported by the package and is used whenever a unit of time must be specified.

enum Unit
{
    case Week;
    case Day;
    case Hour;
    case Minute;
    case Second;
    case Millisecond;
    case Microsecond;
    case Nanosecond;
}

Bound

This Bound enum identifies which interval boundary is being referenced.

enum Bound
{
    case Start;
    case End;
}

Interval Type

The IntervalType enum defines the four possible interval types based on the relative positions of their boundaries and their duration.

enum IntervalType
{
    case Linear;    // returns true   (start < end)
    case Overflow;  // returns false  (start > end)
    case Circular;  // returns false  (start === end and duration is 'P1D')
    case Collapsed; // returns false  (start === end and duration is 'PT0S')
}

The interval types have the following meanings:

  • Linear: the interval progresses normally from start to end.
  • Overflow: the interval wraps past midnight.
  • Circular: the interval spans an entire day.
  • Collapsed: the interval has no duration.

Behavior Modes

Snap Mode

The SnapMode enum determines how values should be rounded when snapping.

enum SnapMode
{
    case Floor;
    case Nearest;
    case Ceil;
}

Available modes:

  • Floor: rounds down to the nearest value.
  • Nearest: rounds to the nearest value.
  • Ceil: rounds up to the nearest value.

Search Mode

The SearchMode enum specifies the search strategy to use.

enum SearchMode
{
    case Linear;
    case Circular;
}

Search modes behave as follows:

  • Linear: searches within a fixed range starting at midnight and ending at the end of the day.
  • Circular: searches without boundaries and wraps beyond the end of the day.

Formatting Settings

Duration format

The DurationFormat enum defines the supported string representations for a Duration.

enum DurationFormat
{
    case Iso8601;
    case Timer;
    case Compact;
    case LargestUnit;
    case TotalUnit
}

Available formats:

  • Iso8601: formats a duration according to the ISO-8601 standard.
  • Timer: formats a duration using timer notation (HH:MM:SS.FF).
  • Compact: formats a duration using a compact representation which omits zero components (1d3h25m3s250µs).
  • LargestUnit: formats a duration using the largest suitable unit that preserves the duration’s precision (25.8d).
  • TotalUnit: formats a duration using the largest unit that preserves the original precision (37152m).

This enum is primarily used by formatting methods operating on Duration objects.

Time Format

The TimeFormat enum defines the supported string representations for a Time.

enum TimeFormat
{
    case Clock;
    case Compact;
}
  • Iso8601Extended : formats a time according to ISO-8601 Extended Time format (HH:MM:SS.FFFFFF);
  • Compact : formats a time using a compact representation (3h25m3s250µs);

Interval format

The IntervalFormat enum defines the supported string representations for an interval.

enum IntervalFormat
{
    case Iso8601StartDuration;
    case Iso8601DurationEnd;
    case Iso8601StartEnd;
    case Iso80000;
    case Bourbaki;
}

Available formats to represent an interval in a string format:

  • Iso8601StartDuration : uses the start boundary and duration, as defined by ISO-8601.
  • Iso8601DurationEnd : uses the duration and end boundary, as defined by ISO-8601.
  • Iso8601StartEnd : uses the start and end boundaries, as defined by ISO-8601.
  • Iso80000 : uses the start and end boundaries together with boundary notation according to ISO-80000.
  • Bourbaki : uses the start and end boundaries together with boundary notation according to Bourbaki notation.

Display Sign

The DisplaySign enum specifies how the duration sign should be represented when the Duration::toNumberString method is used.

enum DisplaySign
{
    case Auto;
    case Always;
}
  • Auto : the sign is only shown when the Duration is negative.
  • Always : the sign is always shown. For a Duration of 0 second, the sign is +.

Localization settings

Time Verbosity

The TimeVerbosity enum specifies the verbosity level used when generating localized Time string representations with the Localize.

enum TimeVerbosity
{
    case Short;
    case Medium;
    case Long;
    case Full;
}

Duration Style

The DurationStyle enum specifies the style used when generating localized Duration string representations with the Localize.

enum DurationStyle
{
    case Decomposed; // Decompose the duration into conventional units.
    case LargestUnit; // Express the duration using the largest suitable unit, allowing fractional values.
    case TotalUnit;  // Express the entire duration using a single unit, choosing the largest unit that preserves the original precision.
}

Unit Width

The UnitWidth enum specifies the width used to represent the unit in the Duration string representations with the Localize.

enum UnitWidth
{
    case Narrow; // the shortest version
    case Short;  // a short version
    case Wide;   // the unit full name
}

List Width

The ListWidth enum specifies the width type used when generating localized Duration string representations with the Localize.

enum ListWidth
{
    case Narrow;
    case Short;
    case Wide;
}
Logo