core / io.islandtime.operators / roundedUpTo

roundedUpTo

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) fun Time.roundedUpTo(unit: TimeUnit): Time
fun OffsetTime.roundedUpTo(unit: TimeUnit): OffsetTime

Return this time, rounded up to match the precision of a given unit.

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) fun DateTime.roundedUpTo(unit: TimeUnit): DateTime
fun OffsetDateTime.roundedUpTo(unit: TimeUnit): OffsetDateTime

Return this date-time, rounded up to match the precision of a given unit.

The start of the next day will be returned when the resulting time is after midnight.

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) fun ZonedDateTime.roundedUpTo(unit: TimeUnit): ZonedDateTime

Return this date-time, rounded up to match the precision of a given unit.

The start of the next day will be returned when the resulting time is after midnight.

Due to daylight savings time transitions, there a few complexities to be aware of. If the new local time falls within a gap (meaning it doesn't exist), it will be adjusted forward by the length of the gap. If it falls within an overlap (meaning the local time exists twice), the offset will be retained if possible. Otherwise, the earlier offset will be used.

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) fun Instant.roundedUpTo(unit: TimeUnit): Instant

Return this instant, rounded up to match the precision of a given unit.