Skip to content

Deprecate Clock.asTimeSource #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 25, 2024
Merged

Deprecate Clock.asTimeSource #450

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b202516
Deprecate Clock.asTimeSource
dkhalanskyjb Oct 18, 2024
c87552f
Suppress deprecations in tests
dkhalanskyjb Oct 18, 2024
2d71a29
Make the deprecation a warning
dkhalanskyjb Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion core/common/src/Clock.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,11 @@ public fun Clock.todayIn(timeZone: TimeZone): LocalDate =
* because [Clock.System] is not well suited for measuring time intervals.
* Please only use this conversion function on the [Clock] instances that are fully controlled programmatically.
*/
@ExperimentalTime
@Deprecated("This function is deprecated because Clock.System.asTimeSource " +
"can be confused with TimeSource.Monotonic, which are very different. " +
"See https://github.com/Kotlin/kotlinx-datetime/issues/372", level = DeprecationLevel.ERROR)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better to keep ExperimentalTime and start with a deprecation warning.

public fun Clock.asTimeSource(): TimeSource.WithComparableMarks = object : TimeSource.WithComparableMarks {
@ExperimentalTime
override fun markNow(): ComparableTimeMark = InstantTimeMark(now(), this@asTimeSource)
}

Expand Down
2 changes: 1 addition & 1 deletion core/common/test/ClockTimeSourceTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import kotlin.time.*
import kotlin.time.Duration.Companion.days
import kotlin.time.Duration.Companion.nanoseconds

@OptIn(ExperimentalTime::class)
@Suppress("DEPRECATION_ERROR")
class ClockTimeSourceTest {
@Test
fun arithmetic() {
Expand Down