klock/com.soywiz.klock

Package com.soywiz.klock

Types

value class Date(val encoded: Int) : Comparable<Date> , Serializable

Represents a triple of year, month and day.

class DateException(msg: String) : RuntimeException

An exception for Date operations.

interface DateFormat

Allows to format and parse instances of Date, DateTime and DateTimeTz

value class DateTime(val unixMillis: Double) : Comparable<DateTime> , Serializable

Represents a Date in UTC (GMT+00) with millisecond precision.

data class DateTimeRange(val from: DateTime, val to: DateTime) : Comparable<DateTime> , Serializable

Represents a right-opened range between two dates.

DateTimeRangeSet

data class DateTimeRangeSet : Serializable

data class DateTimeSpan(val monthSpan: MonthSpan, val timeSpan: TimeSpan) : Comparable<DateTimeSpan> , Serializable

Immutable structure representing a set of a monthSpan and a timeSpan. This structure loses information about which months are included, that makes it impossible to generate a real TimeSpan including months. You can use DateTimeRange.duration to get this information from two real DateTime.

DateTimeSpanFormat

interface DateTimeSpanFormat

class DateTimeTz : Comparable<DateTimeTz> , Serializable

DateTime with an associated TimezoneOffset

enum DayOfWeek : Enum<DayOfWeek> , Serializable

Represents the day of the week. Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

DayOfWeekWithLocale

data class DayOfWeekWithLocale(val dayOfWeek: DayOfWeek, val locale: KlockLocale) : Comparable<DayOfWeekWithLocale>

value class Frequency(val hertz: Double)

object ISO8601

abstract class KlockLocale

KlockLocaleContext

data class KlockLocaleContext(val gender: KlockLocaleGender = KlockLocaleGender.Neuter)

KlockLocaleGender

enum KlockLocaleGender : Enum<KlockLocaleGender>

enum Month : Enum<Month> , Serializable

Represents one of the twelve months of the year.

value class MonthSpan(val totalMonths: Int) : Comparable<MonthSpan> , Serializable

Represents a number of years and months temporal distance.

value class NumberOfTimes(val count: Int)

PatternDateFormat

data class PatternDateFormat @JvmOverloads constructor( val format: String, val locale: KlockLocale? = null, val tzNames: TimezoneNames = TimezoneNames.DEFAULT, val options: PatternDateFormat.Options = Options.DEFAULT) : DateFormat, Serializable

PatternTimeFormat

data class PatternTimeFormat(val format: String, val options: PatternTimeFormat.Options = Options.DEFAULT) : TimeFormat, Serializable

PerformanceCounter

object PerformanceCounter

Class for measuring relative times with as much precision as possible.

class Stopwatch(val nanosecondProvider: () -> Double = { PerformanceCounter.nanoseconds })

value class Time(val encoded: TimeSpan) : Comparable<Time> , Serializable

Represents a union of millisecond, second, minute and hour.

data class TimedResult<T>(val result: T, val time: TimeSpan)

Represents a result associated to a time.

interface TimeFormat

interface TimeProvider

Class to provide time that can be overridden to mock or change its behaviour.

value class TimeSpan(val milliseconds: Double) : Comparable<TimeSpan> , Serializable

Represents a span of time, with milliseconds precision.

data class TimezoneNames(val namesToOffsets: Map<String, TimeSpan>) : Serializable

value class TimezoneOffset(val totalMilliseconds: Double) : Comparable<TimezoneOffset> , Serializable

Represents a time zone offset with millisecond precision. Usually minute is enough. Can be used along DateTimeTz to construct non universal, local times.

value class Year(val year: Int) : Comparable<Year> , Serializable

Represents a Year in a typed way.

value class YearMonth(internalPackedInfo: Int) : Serializable

Represents a couple of year and month.

Functions

fun blockingSleep(time: TimeSpan)

fun blockingSleep(time: HRTimeSpan)

Sleeps the thread during the specified time. Spinlocks on JS

fun DateTime.clamp(min: DateTime, max: DateTime): DateTime

fun TimeSpan.clamp(min: TimeSpan, max: TimeSpan): TimeSpan

inline fun TimeSpan.coalesce(block: () -> TimeSpan): TimeSpan

fun Year.first(dayOfWeek: DayOfWeek): DateTime

fun DateFormat.format(dd: Date): String

fun DateFormat.format(dd: DateTime): String

fun DateFormat.format(date: Double): String

fun DateFormat.format(date: Long): String

fun DateTimeSpanFormat.format(dd: MonthSpan): String

fun DateTimeSpanFormat.format(dd: TimeSpan): String

fun TimeFormat.format(time: Time): String

fun TimeFormat.format(time: Double): String

fun TimeFormat.format(time: Long): String

fun DateTime.format(format: String, locale: KlockLocale): String

fun DateTimeTz.format(format: String, locale: KlockLocale): String

fun Date.inThisWeek(dayOfWeek: DayOfWeekWithLocale): Date

fun Date.inThisWeek(dayOfWeek: DayOfWeek, locale: KlockLocale = KlockLocale.default): Date

fun max(a: DateTime, b: DateTime): DateTime

fun max(a: TimeSpan, b: TimeSpan): TimeSpan

inline fun TimeProvider.measure(block: () -> Unit): TimeSpan

inline fun measureTime(callback: () -> Unit): TimeSpan

Executes a callback and measure the time it takes to complete.

inline fun <T> measureTime(callback: () -> T, handleTime: (TimeSpan) -> Unit): T

measureTimeWithResult

inline fun <T> measureTimeWithResult(callback: () -> T): TimedResult<T>

Executes the callback measuring the time it takes to complete. Returns a TimedResult with the time and the return value of the callback.

fun min(a: DateTime, b: DateTime): DateTime

fun min(a: TimeSpan, b: TimeSpan): TimeSpan

operator fun Date.minus(time: DateTimeSpan): Date

operator fun Date.minus(time: MonthSpan): Date

operator fun Date.minus(time: Time): DateTime

operator fun Date.minus(time: TimeSpan): Date

fun DateFormat.parse(str: String): DateTimeTz

fun DateTimeSpanFormat.parse(str: String): DateTimeSpan

fun TimeFormat.parse(str: String): TimeSpan

fun DateFormat.parseDate(str: String): Date

fun TimeFormat.parseTime(str: String): Time

fun DateFormat.parseUtc(str: String): DateTime

operator fun Date.plus(time: DateTimeSpan): Date

operator fun Date.plus(time: MonthSpan): Date

operator fun Date.plus(time: Time): DateTime

operator fun Date.plus(time: TimeSpan): Date

operator fun Time.plus(span: TimeSpan): Time

roundMilliseconds

fun TimeSpan.roundMilliseconds(): TimeSpan

fun TimeSpan.toFrequency(): Frequency

fun Iterable<DateTimeRange>.toRangeSet(): DateTimeRangeSet

fun List<DateTimeRange>.toStringLongs(): String

fun TimeSpan.toTimeString(components: Int = 3, addMilliseconds: Boolean = false): String

Formats this TimeSpan into something like 12:30:40.100.

infix fun DateTime.until(other: DateTime): DateTimeRange

Generates a right-opened range between two DateTimes

fun DayOfWeek.withLocale(locale: KlockLocale): DayOfWeekWithLocale

fun Year.withMonth(month: Month): YearMonth

Creates a YearMonth representing this year and this month.

fun Month.withYear(year: Year): YearMonth

Creates a YearMonth representing this year and this month.

Properties

val Long.days: TimeSpan

TimeSpan representing this number as days or 86_400 seconds.

val Float.days: TimeSpan

TimeSpan representing this number as days or 86_400 seconds.

val Int.days: TimeSpan

TimeSpan representing this number as days or 86_400 seconds.

val Double.days: TimeSpan

TimeSpan representing this number as days or 86_400 seconds.

val Long.hours: TimeSpan

TimeSpan representing this number as hours or 3_600 seconds.

val Float.hours: TimeSpan

TimeSpan representing this number as hours or 3_600 seconds.

val Int.hours: TimeSpan

TimeSpan representing this number as hours or 3_600 seconds.

val Double.hours: TimeSpan

TimeSpan representing this number as hours or 3_600 seconds.

val TimeSpan.hz: Frequency

val Int.hz: Frequency

val Double.hz: Frequency

val infiniteTimes: NumberOfTimes

val Long.microseconds: TimeSpan

TimeSpan representing this number as microseconds or 1 / 1_000_000 seconds.

val Float.microseconds: TimeSpan

TimeSpan representing this number as microseconds or 1 / 1_000_000 seconds.

val Int.microseconds: TimeSpan

TimeSpan representing this number as microseconds or 1 / 1_000_000 seconds.

val Double.microseconds: TimeSpan

TimeSpan representing this number as microseconds or 1 / 1_000_000 seconds.

val Long.milliseconds: TimeSpan

TimeSpan representing this number as milliseconds or 1 / 1_000 seconds.

val Float.milliseconds: TimeSpan

TimeSpan representing this number as milliseconds or 1 / 1_000 seconds.

val Int.milliseconds: TimeSpan

TimeSpan representing this number as milliseconds or 1 / 1_000 seconds.

val Double.milliseconds: TimeSpan

TimeSpan representing this number as milliseconds or 1 / 1_000 seconds.

val Long.minutes: TimeSpan

TimeSpan representing this number as minutes or 60 seconds.

val Float.minutes: TimeSpan

TimeSpan representing this number as minutes or 60 seconds.

val Int.minutes: TimeSpan

TimeSpan representing this number as minutes or 60 seconds.

val Double.minutes: TimeSpan

TimeSpan representing this number as minutes or 60 seconds.

val Int.months: MonthSpan

Creates a MonthSpan representing these months.

val MonthSpan.months: Int

Months part of this MonthSpan as integer

val Long.nanoseconds: TimeSpan

TimeSpan representing this number as nanoseconds or 1 / 1_000_000_000 seconds.

val Float.nanoseconds: TimeSpan

TimeSpan representing this number as nanoseconds or 1 / 1_000_000_000 seconds.

val Int.nanoseconds: TimeSpan

TimeSpan representing this number as nanoseconds or 1 / 1_000_000_000 seconds.

val Double.nanoseconds: TimeSpan

TimeSpan representing this number as nanoseconds or 1 / 1_000_000_000 seconds.

val TimeSpan.offset: TimezoneOffset

A TimeSpan as a TimezoneOffset.

val Long.seconds: TimeSpan

TimeSpan representing this number as seconds.

val Float.seconds: TimeSpan

TimeSpan representing this number as seconds.

val Int.seconds: TimeSpan

TimeSpan representing this number as seconds.

val Double.seconds: TimeSpan

TimeSpan representing this number as seconds.

val Int.times: NumberOfTimes

val TimeSpan.timesPerSecond: Frequency

val Int.timesPerSecond: Frequency

val Double.timesPerSecond: Frequency

val MonthSpan.totalYears: Double

Total years of this MonthSpan as double (might contain decimals)

val DateTime.weekOfYear0: Int

val DateTimeTz.weekOfYear0: Int

val DateTime.weekOfYear1: Int

val DateTimeTz.weekOfYear1: Int

val Long.weeks: TimeSpan

TimeSpan representing this number as weeks or 604_800 seconds.

val Float.weeks: TimeSpan

TimeSpan representing this number as weeks or 604_800 seconds.

val Int.weeks: TimeSpan

TimeSpan representing this number as weeks or 604_800 seconds.

val Double.weeks: TimeSpan

TimeSpan representing this number as weeks or 604_800 seconds.

val Int.years: MonthSpan

Creates a MonthSpan representing these years.

val MonthSpan.years: Int

Years part of this MonthSpan as integer