Struct TickMsg

pub struct TickMsg {
    pub id: i64,
    pub timeout: bool,
    /* private fields */
}

Message sent on every timer tick to update the countdown.

This message is generated automatically by the timer at regular intervals (determined by the timer’s interval setting). Each tick reduces the remaining timeout duration and triggers the next tick command.

Message Filtering

Timers automatically filter tick messages to ensure they only process their own:

• Messages with mismatched IDs are ignored
• Messages with incorrect tags are rejected (prevents double-ticking)
• Messages sent to stopped timers are ignored

Examples

use bubbletea_widgets::timer::{TickMsg, new};
use std::time::Duration;

let timer = new(Duration::from_secs(30));
let timer_id = timer.id();

// This message would be generated internally by the timer
// Use the timer's tick() method instead of constructing manually:
let tick_cmd = timer.init(); // Starts the timer and generates tick messages

Timeout Detection

The timeout field indicates whether this tick represents the final expiration of the timer. You can either check this field or listen for separate TimeoutMsg messages.

Fields

id: i64

The unique identifier of the timer that generated this tick.

This allows multiple timers to run simultaneously without interfering with each other. Each timer only processes ticks with its own ID.

timeout: bool

Whether this tick represents a timeout (timer expiration).

When true, this indicates the timer has reached zero and expired. You can alternatively listen for TimeoutMsg for timeout notifications.

Trait Implementations

impl Clone for TickMsg

fn clone(&self) -> TickMsg

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TickMsg

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

Formats the value using the given formatter.