r3bl_tui 0.7.7

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

// Copyright (c) 2025 R3BL LLC. Licensed under Apache License, Version 2.0.

/// This is a macro to queue commands to the output device. It locks the output device
/// before queuing the commands, and unlocks it after. This is good for one and done
/// commands that you want to queue and execute in one go. If you have complex
/// interactions with the output device, you should use [`crate::queue_commands_no_lock`!]
/// instead, when you have to explicitly lock the output device and hold the lock for the
/// span of operations that you wish to perform; this avoids undefined behavior (in terms
/// of output order).
#[macro_export]
macro_rules! queue_commands {
    ($output_device:expr $(, $command:expr)* $(,)?) => {{
        use miette::IntoDiagnostic;
        $(
            ::crossterm::QueueableCommand::queue(
                $crate::lock_output_device_as_mut!($output_device),
                $command
            ).into_diagnostic()?;
        )*
    }}
}

/// This is similar to [`queue_commands`!], but it does not lock the output device. The
/// use case for this macro is when you have an already locked output device and you want
/// to queue commands without locking it again. This is important if you don't want to get
/// into issues with output generated in the wrong order, due to lock contention leading
/// to undefined behavior (in terms of output order).
#[macro_export]
macro_rules! queue_commands_no_lock {
    ($writer:expr $(, $command:expr)* $(,)?) => {{
        use miette::IntoDiagnostic;
        $(
            ::crossterm::QueueableCommand::queue(
                $writer,
                $command
            ).into_diagnostic()?;
        )*
    }}
}

/// This is a macro to execute commands to the output device immediately. It locks the
/// output device before executing the commands, and unlocks it after. This is good for
/// one and done commands that you want to execute in one go. If you have complex
/// interactions with the output device, you should use
/// [`crate::execute_commands_no_lock`!] instead, when you have to explicitly lock the
/// output device and hold the lock for the span of operations that you wish to perform;
/// this avoids undefined behavior (in terms of output order).
#[macro_export]
macro_rules! execute_commands {
    ($output_device:expr $(, $command:expr)* $(,)?) => {{
        use miette::IntoDiagnostic;
        $(
            ::crossterm::QueueableCommand::queue(
                $crate::lock_output_device_as_mut!($output_device),
                $command
            ).into_diagnostic()?;
        )*
        $crate::lock_output_device_as_mut!($output_device).flush().into_diagnostic()?;
    }}
}

/// This is similar to [`execute_commands`!], but it does not lock the output device. The
/// use case for this macro is when you have an already locked output device and you want
/// to execute commands without locking it again. This is important if you don't want to
/// get into issues with output generated in the wrong order, due to lock contention
/// leading to undefined behavior (in terms of output order).
#[macro_export]
macro_rules! execute_commands_no_lock {
    ($writer:expr $(, $command:expr)* $(,)?) => {{
        use miette::IntoDiagnostic;
        $(
            ::crossterm::QueueableCommand::queue(
                $writer,
                $command
            ).into_diagnostic()?;
        )*
        $writer.flush().into_diagnostic()?;
    }}
}