r3bl_tui 0.7.2

TUI library to build modern apps inspired by React, Elm, with Flexbox, CSS, editor component, emoji support, and more
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

/*
 *   Copyright (c) 2023-2025 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

use std::fmt::Debug;

use tokio::sync::mpsc::Sender;

use crate::{throws, CommonResult, TerminalWindowMainThreadSignal};

/// This is a simple animator that can be used to run a single animation task. Animators
/// can be re-used (stopped, and restarted repeatedly).
/// - Once a task is started it can be stopped, but another task can't be started.
/// - After a task is stopped, another one can be started again.
#[derive(Debug, Default)]
pub struct Animator {
    /// This is the channel that will be used to kill the animation task.
    /// - [None] means that the animation task is not running.
    /// - When an animation task is started, this will have a [Some] value in it.
    ///
    /// The [Animator::stop](Animator::stop) function uses this channel to kill the
    /// animation task.
    pub animator_kill_channel: Option<Sender<()>>,
}

impl Animator {
    /// Starts an animation task if one isn't already running. The animation task is
    /// actually started by calling the `start_animator_task` callback function. The main
    /// thread signal channel is passed to this callback function. This allows the
    /// animator to communicate with the main thread if needed, for example, to ask for
    /// re-renders.
    ///
    /// Arguments:
    /// 1. `channel_sender`: An action will presumably be dispatched to the app as the
    ///    animation progresses. Essentially some property in the state will be
    ///    manipulated over time and the action is what will change this property.
    /// 2. `start_animator_task_fn`: This is a function that will start the animation
    ///    task. It will typically spawn a Tokio task and return a handle to it.
    pub fn start<AS>(
        &mut self,
        channel_sender: Sender<TerminalWindowMainThreadSignal<AS>>,
        start_animator_task: fn(Sender<TerminalWindowMainThreadSignal<AS>>) -> Sender<()>,
    ) where
        AS: Debug + Default + Clone + Sync + Send,
    {
        if self.is_animation_started() {
            return;
        }
        self.animator_kill_channel = Some(start_animator_task(channel_sender));
    }

    #[must_use]
    pub fn is_animation_started(&self) -> bool {
        matches!(&self.animator_kill_channel, Some(_handle))
    }

    #[must_use]
    pub fn is_animation_not_started(&self) -> bool { !self.is_animation_started() }

    /// # Errors
    ///
    /// Returns an error if the animation cannot be stopped.
    pub fn stop(&mut self) -> CommonResult<()> {
        throws!({
            if let Some(kill_channel) = &self.animator_kill_channel {
                let kill_channel_clone = kill_channel.clone();
                tokio::spawn(async move {
                    // We don't care about the result of this operation.
                    kill_channel_clone.send(()).await.ok();
                });
                self.animator_kill_channel = None;
            }
        });
    }
}