LocalTime

public struct LocalTime

Undocumented

Enumerable

Component
Undocumented
See more
Declaration
Swift

public enum Component : String
PlusComponent
Undocumented
See more
Declaration
Swift

public enum PlusComponent : String
RangeComponent
Undocumented
See more
Declaration
Swift

public enum RangeComponent : String
UntilComponent
Undocumented
See more
Declaration
Swift

public enum UntilComponent : String

Static

midNight
The time of midnight at the start of the day, ‘00:00’.
Declaration
Swift

public static var midNight: LocalTime { get }
noon
The time of noon in the middle of the day, ‘12:00’.
Declaration
Swift

public static var noon: LocalTime { get }
min
The minimum supported LocalTime, ‘00:00’. The maximum supported LocalTime, ‘23:59:59.999999999’.
Declaration
Swift

public static var min: LocalTime { get }
max
The maximum supported LocalTime, ‘23:59:59.999999999’. This is the time just before midnight at the end of the day.
Declaration
Swift

public static var max: LocalTime { get }
hour(_:)
Gets the local time of each hour.
Declaration
Swift

public static func hour(_ hour: Int) -> LocalTime


                    
                    
                    parse(_:clock:)

Obtains an instance of LocalTime from a text string such as 10:15:00.

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

Declaration

Swift

public static func parse(_ text: String, clock: Clock) -> LocalTime?

Parameters

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

Return Value

The parsed local time.


                    
                    
                    parse(_:timeZone:)

Obtains an instance of LocalTime from a text string such as 10:15:00.

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

Declaration

Swift

static public func parse(_ text: String, timeZone: TimeZone = TimeZone.current) -> LocalTime?

Parameters

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

Return Value

The parsed local time.


                    
                    
                    parse(_:formatter:clock:)

Obtains an instance of LocalTime 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) -> LocalTime?

Parameters

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

Return Value

The parsed local time.


                    
                    
                    parse(_:formatter:timeZone:)

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

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

Declaration

Swift

static public func parse(_ text: String, formatter: DateFormatter, timeZone: TimeZone = TimeZone.current) -> LocalTime?

Parameters

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

Return Value

The parsed local time.

Property

hour
Gets the hour-of-day field.
Declaration
Swift

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

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

public var second: Int { get set }
nano
Gets the nano-of-second field from 0 to 999,999,999.
Declaration
Swift

public var nano: Int { get set }
secondOfDay
Gets the time as seconds of day,
Declaration
Swift

public var secondOfDay: Int { get }
nanoOfDay
Gets the time as nanos of day,
Declaration
Swift

public var nanoOfDay: Int64 { get }

Public

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 = TimeZone.current) -> Date


                    
                    
                    with(component:newValue:)

Returns a copy of this time with the specified field set to a new value.

Declaration

Swift

public func with(component: Component, newValue: Int) -> LocalTime

Parameters

`component`	The field to set in the result.
`newValue`	The new value of the field in the result.

Return Value

An LocalTime based on this with the specified field set.

with(hour:)
Returns a copy of this LocalTime with the hour-of-day value altered.
Declaration
Swift

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

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

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

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

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

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

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

An LocalTime based on this with the specified field set.


                    
                    
                    plus(component:newValue:)

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

Results: An LocalTime based on this time with the specified amount added.

Declaration

Swift

public func plus(component: PlusComponent, newValue: Int) -> LocalTime

Parameters

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

plus(hour:)
Returns a copy of this LocalTime with the specified period in hours added.
- Results: An LocalTime based on this time with the specified amount added.
Declaration
Swift

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

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

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

public func plus(nano: Int) -> LocalTime


                    
                    
                    minus(component:newValue:)

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

Results: An LocalTime based on this time with the specified amount subtracted.

Declaration

Swift

public func minus(component: PlusComponent, newValue: Int) -> LocalTime

Parameters

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

minus(hour:)
Returns a copy of this LocalTime with the specified period in hours subtracted.
- Results: An LocalTime based on this time with the specified amount subtracted.
Declaration
Swift

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

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

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

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

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

The range of valid values for the field.


                    
                    
                    until(endTime:)

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

Declaration

Swift

public func until(endTime: LocalTime) -> Period

Parameters


                                endTime

The end time, exclusive, which is converted to an LocalTime.

Return Value

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


                    
                    
                    until(endTime:component:)

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

Declaration

Swift

public func until(endTime: LocalTime, component: UntilComponent) -> Int64

Parameters

`endTime`	The end time, exclusive, which is converted to an LocalTime.
`component`	The unit to measure the amount in.

Return Value

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

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

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

The formatted date string.

Operator


                    
                    
                    +(_:_:)

Undocumented

Declaration

Swift

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


                    
                    
                    +=(_:_:)

Undocumented

Declaration

Swift

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


                    
                    
                    -(_:_:)

Undocumented

Declaration

Swift

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


                    
                    
                    -=(_:_:)

Undocumented

Declaration

Swift

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

Lifecycle

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

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

public init(timeZone: TimeZone = TimeZone.current)
init(_:clock:)
Creates a local time from an instance of Date.
Declaration
Swift

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

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

public init(_ time: LocalTime)
init(hour:minute:second:nanoOfSecond:)
Creates an instance of LocalTime from an hour, minute, second and nanosecond.
Declaration
Swift

public init(hour: Int, minute: Int, second: Int = 0, nanoOfSecond: Int = 0)
init(secondOfDay:)
Creates an instance of LocalTime from a second-of-day value.
Declaration
Swift

public init(secondOfDay: Int)
init(nanoOfDay:)
Creates an instance of LocalTime from a nanos-of-day value.
Declaration
Swift

public init(nanoOfDay: Int64)

<(_:_:)
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: LocalTime, rhs: LocalTime) -> 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: LocalTime, rhs: LocalTime) -> 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: LocalTime, rhs: LocalTime) -> 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: LocalTime, rhs: LocalTime) -> 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: LocalTime, rhs: LocalTime) -> 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.