Struct TimerHandle 

pub struct TimerHandle { /* private fields */ }

Handle to a scheduled timer with RAII cancellation.

When dropped, the handle automatically cancels the timer if it hasn’t fired yet. This follows the RAII pattern for resource management.

Example

use reovim_kernel::api::v1::*;
use std::time::Duration;

let mut runtime = Runtime::new();
runtime.boot();

{
    // Timer is scheduled
    let handle = runtime.schedule_delayed(Duration::from_secs(10), || {
        println!("This won't print");
    });
    // handle dropped here - timer is cancelled
}

// Timer was cancelled, won't fire

Manual Cancellation

You can also explicitly cancel via Runtime::cancel_timer:

use reovim_kernel::api::v1::*;
use std::time::Duration;

let mut runtime = Runtime::new();
runtime.boot();

let handle = runtime.schedule_delayed(Duration::from_secs(10), || {});
let id = handle.id();

// Explicit cancellation
std::mem::forget(handle); // Prevent drop cancellation
let was_pending = runtime.cancel_timer(id);

Implementations

impl TimerHandle

pub const fn id(&self) -> TimerId

Get the timer’s unique identifier.

pub const fn is_failed(&self) -> bool

Check if this handle represents a failed scheduling attempt.

Returns true if the timer was not actually scheduled (e.g., due to hitting the max_timers limit).

pub fn detach(self) -> TimerId

Prevent automatic cancellation on drop.

After calling this, dropping the handle will NOT cancel the timer. Use this when you want the timer to fire regardless of handle lifetime.

Returns the timer ID for manual cancellation if needed later.

Trait Implementations

impl Debug for TimerHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for TimerHandle

fn drop(&mut self)

Executes the destructor for this type.