Skip to content
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

gloo_timers, ambiguous verbage #255

Merged
merged 6 commits into from
Sep 23, 2022
+10 −6
Merged

gloo_timers, ambiguous verbage #255

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
008fba5
Closes #254, Documentation updates
Sep 21, 2022
c33a0fd
Improvements to #254
Sep 21, 2022
074b78e
Update crates/timers/src/callback.rs
simbleau Sep 23, 2022
3a27bc7
Update crates/timers/src/callback.rs
simbleau Sep 23, 2022
d8f864b
Update crates/timers/src/callback.rs
simbleau Sep 23, 2022
1396cbd
Update callback.rs
simbleau Sep 23, 2022
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
16 changes: 10 additions & 6 deletions crates/timers/src/callback.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ extern "C" {
///
/// See `Timeout::new` for scheduling new timeouts.
///
/// Once scheduled, you can either `cancel` so that it doesn't run or `forget`
/// it so that it is un-cancel-able.
/// Once scheduled, you can [`drop`] the [`Timeout`] to clear it or [`forget`](Timeout::forget) to leak it. Once forgotten, the interval will keep running forever.
/// This pattern is known as Resource Acquisition Is Initialization (RAII).
#[derive(Debug)]
#[must_use = "timeouts cancel on drop; either call `forget` or `drop` explicitly"]
pub struct Timeout {
Expand All @@ -33,6 +33,8 @@ pub struct Timeout {
}

impl Drop for Timeout {
/// Disposes of the timeout, dually cancelling this timeout by calling
/// `clearTimeout` directly.
fn drop(&mut self) {
if let Some(id) = self.id {
clear_timeout(id);
Expand Down Expand Up @@ -71,7 +73,7 @@ impl Timeout {
}
}

/// Make this timeout uncancel-able.
/// Forgets this resource without clearing the timeout.
///
/// Returns the identifier returned by the original `setTimeout` call, and
/// therefore you can still cancel the timeout by calling `clearTimeout`
Expand Down Expand Up @@ -123,8 +125,8 @@ impl Timeout {
///
/// See `Interval::new` for scheduling new intervals.
///
/// Once scheduled, you can either `cancel` so that it ceases to fire or `forget`
/// it so that it is un-cancel-able.
/// Once scheduled, you can [`drop`] the [`Interval`] to clear it or [`forget`](Interval::forget) to leak it. Once forgotten, the interval will keep running forever.
/// This pattern is known as Resource Acquisition Is Initialization (RAII).
#[derive(Debug)]
#[must_use = "intervals cancel on drop; either call `forget` or `drop` explicitly"]
pub struct Interval {
Expand All @@ -133,6 +135,8 @@ pub struct Interval {
}

impl Drop for Interval {
/// Disposes of the interval, dually cancelling this interval by calling
/// `clearInterval` directly.
fn drop(&mut self) {
if let Some(id) = self.id {
clear_interval(id);
Expand Down Expand Up @@ -170,7 +174,7 @@ impl Interval {
}
}

/// Make this interval uncancel-able.
/// Forget this resource without clearing the interval.
///
/// Returns the identifier returned by the original `setInterval` call, and
/// therefore you can still cancel the interval by calling `clearInterval`
Expand Down