TemporalSpec

public protocol TemporalSpec

The TemporalSpec protocol defines an ISO-8601 formatted Date value. Types that conform to this protocol are responsible for providing the parsing and formatting logic with the correct granularity.

now()
A static builder that return an instance that represent the current point in time.
Declaration
Swift

static func now() -> Self
foundationDate
The underlying Date object. All TemporalSpec implementations must be backed by a Foundation Date instance.
Declaration
Swift

var foundationDate: Foundation.Date { get }
timeZone
The timezone field is an optional field used to specify the timezone associated with a particular date.
Declaration
Swift

var timeZone: TimeZone? { get }
iso8601String Default implementation
The ISO-8601 formatted string in the UTC TimeZone.

See also
iso8601FormattedString(TemporalFormat, TimeZone) -> String

Default Implementation

The ISO8601 representation of the scalar using .full as the format and .utc as TimeZone.

See also
iso8601FormattedString(format:timeZone:)
Declaration
Swift

var iso8601String: String { get }
init(iso8601String:) Default implementation
Parses an ISO-8601 String into a TemporalSpec.

Note

if no timezone is present in the string, .autoupdatingCurrent is used.
- Parameters
  
  iso8601String: the string in the ISO8601 format
Throws

DataStoreError.decodeError in case the provided string is not formatted as expected by the scalar type.

Important

This will cycle through all available formats for the concrete type. If you know the format, use init(iso8601String:format:) throws instead.
Default Implementation
Declaration
Swift

init(iso8601String: String) throws
init(iso8601String:format:) Default implementation
Parses an ISO-8601 String into a TemporalSpec.

Note

if no timezone is present in the string, .autoupdatingCurrent is used.
- Parameters
  
  iso8601String: the string in the ISO8601 format
  
  format: The TemporalFormat of the iso8601String
Throws

DataStoreError.decodeError in case the provided string is not formatted as expected by the scalar type.
Default Implementation
Declaration
Swift

init(iso8601String: String, format: TemporalFormat) throws


                    
                    
                    init(_:timeZone:)

Constructs a TemporalSpec from a Date object.

Declaration

Swift

init(_ date: Foundation.Date, timeZone: TimeZone?)

Parameters


                                date

The Date instance that will be used as the reference of the TemporalSpec instance.


                    
                    
                    iso8601FormattedString(format:timeZone:)

Default implementation

A string representation of the underlying date formatted using ISO8601 rules.

Default Implementation

Create an iso8601 String with the desired format option for this spec.

Declaration

Swift

func iso8601FormattedString(format: TemporalFormat, timeZone: TimeZone) -> String

Parameters

`format`	the desired `TemporalFormat`.
`timeZone`	the target `TimeZone`

Return Value

the ISO8601 formatted string in the requested format

Available where `Self`: `DateUnitOperable`


                    
                    
                    +(_:_:)

Extension method

Add a DateUnit to a Temporal.Date or Temporal.DateTime

let tomorrow = Temporal.Date.now() + .days(1)

Declaration

Swift

public static func + (left: Self, right: DateUnit) -> Self

Parameters

`left`	`Temporal.Date` or `Temporal.DateTime`
`right`	`DateUnit` to add to `left`

Return Value

A new Temporal.Date or Temporal.DateTime the DateUnit was added to.


                    
                    
                    -(_:_:)

Extension method

Subtract a DateUnit from a Temporal.Date or Temporal.DateTime

let yesterday = Temporal.Date.now() - .day(1)

Declaration

Swift

public static func - (left: Self, right: DateUnit) -> Self

Parameters

`left`	`Temporal.Date` or `Temporal.DateTime`
`right`	`DateUnit` to subtract from `left`

Return Value

A new Temporal.Date or Temporal.DateTime the DateUnit was subtracted from.

Available where `Self`: `Codable`


                    
                    
                    init(from:)

Extension method

Declaration

Swift

public init(from decoder: Decoder) throws


                    
                    
                    encode(to:)

Extension method

Declaration

Swift

public func encode(to encoder: Encoder) throws

Available where `Self`: `Comparable`


                    
                    
                    ==(_:_:)

Extension method

Declaration

Swift

public static func == (lhs: Self, rhs: Self) -> Bool


                    
                    
                    <(_:_:)

Extension method

Declaration

Swift

public static func < (lhs: Self, rhs: Self) -> Bool

Available where `Self`: `TimeUnitOperable`


                    
                    
                    +(_:_:)

Extension method

Add a TimeUnit to a Temporal.Time or Temporal.DateTime

Declaration

Swift

public static func + (left: Self, right: TimeUnit) -> Self

Parameters

`left`	`Temporal.Time` or `Temporal.DateTime`
`right`	`TimeUnit` to add to `left`

Return Value

A new Temporal.Time or Temporal.DateTime the TimeUnit was added to.


                    
                    
                    -(_:_:)

Extension method

Subtract a TimeUnit from a Temporal.Time or Temporal.DateTime

Declaration

Swift

public static func - (left: Self, right: TimeUnit) -> Self

Parameters

`left`	`Temporal.Time` or `Temporal.DateTime`
`right`	`TimeUnit` to subtract from `left`

Return Value

A new Temporal.Time or Temporal.DateTime the TimeUnit was subtracted from.

TemporalSpec

Declaration

Declaration

Declaration

Default Implementation

Declaration

Default Implementation

Declaration

Default Implementation

Declaration

Declaration

Parameters

Default Implementation

Declaration

Parameters

Return Value

Available where Self: DateUnitOperable

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Available where Self: Codable

Declaration

Declaration

Available where Self: Comparable

Declaration

Declaration

Available where Self: TimeUnitOperable

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Available where `Self`: `DateUnitOperable`

Available where `Self`: `Codable`

Available where `Self`: `Comparable`

Available where `Self`: `TimeUnitOperable`