Struct TimeoutMsg 

pub struct TimeoutMsg {
    pub id: i64,
}

Message sent when a timer reaches zero and expires.

This is a convenience message that provides a clear notification when a timer completes its countdown. It’s sent in addition to the final TickMsg (which will have timeout: true), giving applications two ways to detect timer expiration.

Usage Pattern

Applications typically handle this message in their update loop to respond to timer completion events, such as showing notifications, triggering actions, or starting new timers.

Examples

use bubbletea_widgets::timer::{TimeoutMsg, new};
use bubbletea_rs::{Model as BubbleTeaModel, Msg};
use std::time::Duration;

struct App {
    timer: bubbletea_widgets::timer::Model,
    message: String,
}

impl BubbleTeaModel for App {
    fn update(&mut self, msg: Msg) -> Option<bubbletea_rs::Cmd> {
        // Handle timer timeout
        if let Some(timeout) = msg.downcast_ref::<TimeoutMsg>() {
            if timeout.id == self.timer.id() {
                self.message = "Timer expired!".to_string();
            }
        }
         
        self.timer.update(msg)
    }

    // ... other methods
}

Relationship to TickMsg

While TickMsg with timeout: true and TimeoutMsg both indicate timer expiration, TimeoutMsg provides a cleaner, more semantic way to handle completion events in your application logic.

Fields

id: i64

The unique identifier of the timer that expired.

Use this to identify which timer expired when multiple timers are running in the same application.

Trait Implementations

impl Clone for TimeoutMsg

fn clone(&self) -> TimeoutMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeoutMsg

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

Formats the value using the given formatter.