ZonedDateTime

public struct ZonedDateTime

Undocumented

Static

min
The minimum supported ZonedDateTime from the system clock in the default time-zone, ‘-999999999-01-01T00:00:00’.
Declaration
Swift

public static var min: ZonedDateTime { get }
max
The maximum supported ZonedDateTime from the system clock in the default time-zone, ‘+999999999-12-31T23:59:59.999999999’.
Declaration
Swift

public static var max: ZonedDateTime { get }


                    
                    
                    parse(_:clock:)

Obtains an instance of ZonedDateTime from a text string such as ‘2007-12-03T10:15:30.217Z’.

If the input text and date format are mismatched, returns nil.

Declaration

Swift

public static func parse(_ text: String, clock: Clock = Clock.current) -> ZonedDateTime?

Parameters

`text`	The text to parse.
`clock`	The Clock instance.

Return Value

The parsed zoned date-time.


                    
                    
                    parse(_:timeZone:)

Obtains an instance of ZonedDateTime from a text string such as ‘2007-12-03T10:15:30.217Z’.

If the input text and date format are mismatched, returns nil.

Declaration

Swift

public static func parse(_ text: String, timeZone: TimeZone) -> ZonedDateTime?

Parameters

`text`	The text to parse.
`timeZone`	The TimeZone instance.

Return Value

The parsed zoned date-time.


                    
                    
                    parse(_:formatter:clock:)

Obtains an instance of ZonedDateTime from a text string using a specific formatter.

If the input text and date format are mismatched, returns nil.

Declaration

Swift

public static func parse(_ text: String, formatter: DateFormatter, clock: Clock = Clock.current) -> ZonedDateTime?

Parameters

`text`	The text to parse.
`formatter`	The formatter to parse.
`clock`	The Clock instance.

Return Value

The parsed zoned date-time.


                    
                    
                    parse(_:formatter:timeZone:)

Obtains an instance of ZonedDateTime from a text string using a specific formatter.

If the input text and date format are mismatched, returns nil.

Declaration

Swift

public static func parse(_ text: String, formatter: DateFormatter, timeZone: TimeZone) -> ZonedDateTime?

Parameters

`text`	The text to parse.
`formatter`	The formatter to parse.
`timeZone`	The TimeZone instance.

Return Value

The parsed zoned date-time.

Property

clock
Gets the Clock part of this date-time.
Declaration
Swift

public var clock: Clock { get }
timeZone
Gets the TimeZone part of this date-time.
Declaration
Swift

public var timeZone: TimeZone { get }


                    
                    
                    localDateTime

Gets the LocalDateTime part of this date-time.

Declaration

Swift

public fileprivate(set) var localDateTime: LocalDateTime { get set }

localDate
Gets the LocalDate part of this date-time.
Declaration
Swift

public var localDate: LocalDate { get }
localTime
Gets the LocalTime part of this date-time.
Declaration
Swift

public var localTime: LocalTime { get }
year
Gets the year field.
Declaration
Swift

public var year: Int { get set }
month
Gets the month-of-year field from 1 to 12.
Declaration
Swift

public var month: Int { get set }
day
Gets the day-of-month field.
Declaration
Swift

public var day: Int { get set }
dayOfWeek
Gets the day-of-week field.
Declaration
Swift

public var dayOfWeek: Int { get }
hour
Gets the hour-of-day field.
Declaration
Swift

public var hour: Int { get set }
minute
Gets the minute-of-hour field.
Declaration
Swift

public var minute: Int { get set }
second
Gets the second-of-minute field.
Declaration
Swift

public var second: Int { get set }
nano
Gets the nano-of-second field.
Declaration
Swift

public var nano: Int { get set }

Public

lengthOfMonth()
Returns the length of the month represented by this date.
Declaration
Swift

public func lengthOfMonth() -> Int
lengthOfYear()
Returns the length of the year represented by this date.
Declaration
Swift

public func lengthOfYear() -> Int
isLeapYear()
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
Declaration
Swift

public func isLeapYear() -> Bool
toDate(clock:)
Returns an instance of Date.
Declaration
Swift

public func toDate(clock: Clock?) -> Date
toDate(timeZone:)
Returns an instance of Date.
Declaration
Swift

public func toDate(timeZone: TimeZone? = nil) -> Date
with(zoneSameLocal:)
Returns a copy of this date-time with a different time-zone, retaining the local date-time if possible.
Declaration
Swift

public func with(zoneSameLocal clock: Clock) -> ZonedDateTime
Return Value

A ZonedDateTime based on this date-time with the requested zone.
with(zoneSameLocal:)
Returns a copy of this date-time with a different time-zone, retaining the local date-time if possible.
Declaration
Swift

public func with(zoneSameLocal timeZone: TimeZone) -> ZonedDateTime
Return Value

A ZonedDateTime based on this date-time with the requested zone.
with(zoneSameInstant:)
Returns a copy of this date-time with a different time-zone, retaining the instant.
Declaration
Swift

public func with(zoneSameInstant clock: Clock) -> ZonedDateTime
Return Value

A ZonedDateTime based on this date-time with the requested zone.
with(zoneSameInstant:)
Returns a copy of this date-time with a different time-zone, retaining the instant.
Declaration
Swift

public func with(zoneSameInstant timeZone: TimeZone) -> ZonedDateTime
Return Value

A ZonedDateTime based on this date-time with the requested zone.
with(year:)
Returns a copy of this ZonedDateTime with the year value altered.
Declaration
Swift

public func with(year: Int) -> ZonedDateTime
Return Value

An ZonedDateTime based on this with the specified field set.
with(month:)
Returns a copy of this ZonedDateTime with the month-of-year value altered.
Declaration
Swift

public func with(month: Int) -> ZonedDateTime
Return Value

An ZonedDateTime based on this with the specified field set.
with(day:)
Returns a copy of this ZonedDateTime with the day-of-month value altered.
Declaration
Swift

public func with(day: Int) -> ZonedDateTime
Return Value

An ZonedDateTime based on this with the specified field set.
with(hour:)
Returns a copy of this ZonedDateTime with the hour-of-day value altered.
Declaration
Swift

public func with(hour: Int) -> ZonedDateTime
Return Value

An ZonedDateTime based on this with the specified field set.
with(minute:)
Returns a copy of this ZonedDateTime with the minute-of-hour value altered.
Declaration
Swift

public func with(minute: Int) -> ZonedDateTime
Return Value

An ZonedDateTime based on this with the specified field set.
with(second:)
Returns a copy of this ZonedDateTime with the second-of-minute value altered.
Declaration
Swift

public func with(second: Int) -> ZonedDateTime
Return Value

An ZonedDateTime based on this with the specified field set.
with(nano:)
Returns a copy of this ZonedDateTime with the nano-of-second value altered.
Declaration
Swift

public func with(nano: Int) -> ZonedDateTime
Return Value

An ZonedDateTime based on this with the specified field set.


                    
                    
                    plus(component:newValue:)

Returns a copy of this ZonedDateTime with the specified amount added.

Results: An ZonedDateTime based on this date-time with the specified amount added.

Declaration

Swift

public func plus(component: LocalDateTime.PlusComponent, newValue: Int) -> ZonedDateTime

Parameters

`component`	The unit of the amount to add.
`newValue`	The amount of the unit to add to the result.

plus(year:)
Returns a copy of this ZonedDateTime with the specified period in years added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(year: Int) -> ZonedDateTime
plus(month:)
Returns a copy of this ZonedDateTime with the specified period in months added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(month: Int) -> ZonedDateTime
plus(week:)
Returns a copy of this ZonedDateTime with the specified period in weeks added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(week: Int) -> ZonedDateTime
plus(day:)
Returns a copy of this ZonedDateTime with the specified period in days added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(day: Int) -> ZonedDateTime
plus(hour:)
Returns a copy of this ZonedDateTime with the specified period in hours added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(hour: Int) -> ZonedDateTime
plus(minute:)
Returns a copy of this ZonedDateTime with the specified period in minutes added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(minute: Int) -> ZonedDateTime
plus(second:)
Returns a copy of this ZonedDateTime with the specified period in seconds added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(second: Int) -> ZonedDateTime
plus(nano:)
Returns a copy of this ZonedDateTime with the specified period in nanoseconds added.
- Results: An ZonedDateTime based on this date-time with the specified amount added.
Declaration
Swift

public func plus(nano: Int) -> ZonedDateTime


                    
                    
                    minus(component:newValue:)

Returns a copy of this ZonedDateTime with the specified amount subtracted.

Results: An ZonedDateTime based on this date-time with the specified amount subtracted.

Declaration

Swift

public func minus(component: LocalDateTime.PlusComponent, newValue: Int) -> ZonedDateTime

Parameters

`component`	The unit of the amount to subtract.
`newValue`	The amount of the unit to subtract to the result.

minus(year:)
Returns a copy of this ZonedDateTime with the specified period in years subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(year: Int) -> ZonedDateTime
minus(month:)
Returns a copy of this ZonedDateTime with the specified period in months subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(month: Int) -> ZonedDateTime
minus(week:)
Returns a copy of this ZonedDateTime with the specified period in weeks subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(week: Int) -> ZonedDateTime
minus(day:)
Returns a copy of this ZonedDateTime with the specified period in days subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(day: Int) -> ZonedDateTime
minus(hour:)
Returns a copy of this ZonedDateTime with the specified period in hours subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(hour: Int) -> ZonedDateTime
minus(minute:)
Returns a copy of this ZonedDateTime with the specified period in minutes subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(minute: Int) -> ZonedDateTime
minus(second:)
Returns a copy of this ZonedDateTime with the specified period in seconds subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(second: Int) -> ZonedDateTime
minus(nano:)
Returns a copy of this ZonedDateTime with the specified period in nanoseconds subtracted.
- Results: An ZonedDateTime based on this date-time with the specified amount subtracted.
Declaration
Swift

public func minus(nano: Int) -> ZonedDateTime
range(_:)
Gets the range of valid values for the specified field.
Declaration
Swift

public func range(_ component: LocalDateTime.RangeComponent) -> (Int, Int)
Return Value

The range of valid values for the field.


                    
                    
                    until(endDateTime:)

Calculates the period between this ZonedDateTime and another ZonedDateTime as a Period.

Declaration

Swift

public func until(endDateTime: ZonedDateTime) -> Period

Parameters


                                endDateTime

The end date-time, exclusive, which is converted to an ZonedDateTime.

Return Value

The Period of time between this date-time and the end date-time.


                    
                    
                    until(endDateTime:component:)

Calculates the amount of time until another ZonedDateTime in terms of the specified unit.

Declaration

Swift

public func until(endDateTime: ZonedDateTime, component: LocalDateTime.UntilComponent) -> Int64

Parameters

`endDateTime`	The end date-time, exclusive, which is converted to an ZonedDateTime.
`component`	The unit to measure the amount in.

Return Value

The amount of time between this date-time and the end date-time.

format(_:)
Formats this time using the specified formatter.
Declaration
Swift

public func format(_ formatter: DateFormatter) -> String
Return Value

The formatted date string.

Operator


                    
                    
                    +(_:_:)

ZonedDateTime

Declaration

Swift

public static func + (lhs: ZonedDateTime, rhs: ZonedDateTime) -> ZonedDateTime


                    
                    
                    +=(_:_:)

Undocumented

Declaration

Swift

public static func += (lhs: inout ZonedDateTime, rhs: ZonedDateTime)


                    
                    
                    -(_:_:)

Undocumented

Declaration

Swift

public static func - (lhs: ZonedDateTime, rhs: ZonedDateTime) -> ZonedDateTime


                    
                    
                    -=(_:_:)

Undocumented

Declaration

Swift

public static func -= (lhs: inout ZonedDateTime, rhs: ZonedDateTime)


                    
                    
                    +(_:_:)

LocalDateTime

Declaration

Swift

public static func + (lhs: ZonedDateTime, rhs: LocalDateTime) -> ZonedDateTime


                    
                    
                    +=(_:_:)

Undocumented

Declaration

Swift

public static func += (lhs: inout ZonedDateTime, rhs: LocalDateTime)


                    
                    
                    -(_:_:)

Undocumented

Declaration

Swift

public static func - (lhs: ZonedDateTime, rhs: LocalDateTime) -> ZonedDateTime


                    
                    
                    -=(_:_:)

Undocumented

Declaration

Swift

public static func -= (lhs: inout ZonedDateTime, rhs: LocalDateTime)


                    
                    
                    +(_:_:)

LocalDate

Declaration

Swift

public static func + (lhs: ZonedDateTime, rhs: LocalDate) -> ZonedDateTime


                    
                    
                    +=(_:_:)

Undocumented

Declaration

Swift

public static func += (lhs: inout ZonedDateTime, rhs: LocalDate)


                    
                    
                    -(_:_:)

Undocumented

Declaration

Swift

public static func - (lhs: ZonedDateTime, rhs: LocalDate) -> ZonedDateTime


                    
                    
                    -=(_:_:)

Undocumented

Declaration

Swift

public static func -= (lhs: inout ZonedDateTime, rhs: LocalDate)


                    
                    
                    +(_:_:)

LocalTime

Declaration

Swift

public static func + (lhs: ZonedDateTime, rhs: LocalTime) -> ZonedDateTime


                    
                    
                    +=(_:_:)

Undocumented

Declaration

Swift

public static func += (lhs: inout ZonedDateTime, rhs: LocalTime)


                    
                    
                    -(_:_:)

Undocumented

Declaration

Swift

public static func - (lhs: ZonedDateTime, rhs: LocalTime) -> ZonedDateTime


                    
                    
                    -=(_:_:)

Undocumented

Declaration

Swift

public static func -= (lhs: inout ZonedDateTime, rhs: LocalTime)

Lifecycle

init(clock:)
Creates the current date-time from the time-zone.
Declaration
Swift

public init(clock: Clock = Clock.current)
init(timeZone:)
Creates the current date-time from the time-zone.
Declaration
Swift

public init(timeZone: TimeZone)
init(_:clock:)
Creates a ZonedDateTime from an instance of Date.
Declaration
Swift

public init(_ date: Date, clock: Clock = Clock.current)
init(_:timeZone:)
Creates a ZonedDateTime from an instance of Date.
Declaration
Swift

public init(_ date: Date, timeZone: TimeZone)
init(_:)
Copies an instance of ZonedDateTime.
Declaration
Swift

public init(_ dateTime: ZonedDateTime)
init(_:clock:)
Creates an instance of ZonedDateTime from an instance of LocalDateTime.
Declaration
Swift

public init(_ dateTime: LocalDateTime, clock: Clock = Clock.current)
init(_:timeZone:)
Creates an instance of ZonedDateTime from an instance of LocalDateTime.
Declaration
Swift

public init(_ dateTime: LocalDateTime, timeZone: TimeZone)
init(date:time:clock:)
Returns a copy of this date-time with the new date and time, checking to see if a new object is in fact required.
Declaration
Swift

public init(date: LocalDate, time: LocalTime, clock: Clock = Clock.current)
init(date:time:timeZone:)
Returns a copy of this date-time with the new date and time, checking to see if a new object is in fact required.
Declaration
Swift

public init(date: LocalDate, time: LocalTime, timeZone: TimeZone)
init(year:month:day:hour:minute:second:nanoOfSecond:clock:)
Creates an instance of ZonedDateTime from year, month, day, hour, minute, second and nanosecond.
Declaration
Swift

public init(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Int, nanoOfSecond: Int, clock: Clock = Clock.current)
init(year:month:day:hour:minute:second:nanoOfSecond:timeZone:)
Creates an instance of ZonedDateTime from year, month, day, hour, minute, second and nanosecond.
Declaration
Swift

public init(year: Int, month: Int, day: Int, hour: Int, minute: Int, second: Int, nanoOfSecond: Int, timeZone: TimeZone)
init(epochDay:nanoOfDay:clock:)
Creates an instance of ZonedDateTime using seconds from the epoch of 1970-01-01T00:00:00Z.
Declaration
Swift

public init(epochDay: Int64, nanoOfDay: Int64, clock: Clock = Clock.current)
init(epochDay:nanoOfDay:timeZone:)
Creates an instance of ZonedDateTime using seconds from the epoch of 1970-01-01T00:00:00Z.
Declaration
Swift

public init(epochDay: Int64, nanoOfDay: Int64, timeZone: TimeZone)

<(_:_:)
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
Declaration
Swift

public static func < (lhs: ZonedDateTime, rhs: ZonedDateTime) -> Bool
>(_:_:)
Returns a Boolean value indicating whether the value of the first argument is greater than that of the second argument.
Declaration
Swift

public static func > (lhs: ZonedDateTime, rhs: ZonedDateTime) -> Bool
<=(_:_:)
Returns a Boolean value indicating whether the value of the first argument is less than or equal to that of the second argument.
Declaration
Swift

public static func <= (lhs: ZonedDateTime, rhs: ZonedDateTime) -> Bool
>=(_:_:)
Returns a Boolean value indicating whether the value of the first argument is greater than or equal to that of the second argument.
Declaration
Swift

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

hashValue
The hash value.

Hash values are not guaranteed to be equal across different executions of your program. Do not save hash values to use during a future execution.
Declaration
Swift

public var hashValue: Int { get }

==(_:_:)
Returns a Boolean value indicating whether two values are equal.
Declaration
Swift

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

description
A textual representation of this instance.
Declaration
Swift

public var description: String { get }
debugDescription
A textual representation of this instance, suitable for debugging.
Declaration
Swift

public var debugDescription: String { get }

customMirror
The custom mirror for this instance.

If this type has value semantics, the mirror should be unaffected by subsequent mutations of the instance.
Declaration
Swift

public var customMirror: Mirror { get }

playgroundDescription
Returns the custom playground description for this instance.

If this type has value semantics, the instance returned should be unaffected by subsequent mutations if possible.
Declaration
Swift

public var playgroundDescription: Any { get }


                    
                    
                    init(from:)

Creates a new instance by decoding from the given decoder.

This initializer throws an error if reading from the decoder fails, or if the data read is corrupted or otherwise invalid.

Declaration

Swift

public init(from decoder: Decoder) throws

Parameters


                                decoder

The decoder to read data from.


                    
                    
                    encode(to:)

Encodes this value into the given encoder.

If the value fails to encode anything, encoder will encode an empty keyed container in its place.

This function throws an error if any values are invalid for the given encoder’s format.

Declaration

Swift

public func encode(to encoder: Encoder) throws

Parameters


                                encoder

The encoder to write data to.