tuirealm 4.0.0

A tui-rs framework to build tui interfaces, inspired by React and Elm.
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

//! This module exposes the [`Cmd`] type, which must be used when sending commands to the [`Component`](crate::component::Component) from the
//! [`AppComponent`](crate::component::AppComponent) after an `Event`.

use crate::state::State;

// -- Command

/// A command defines the "abstract" operation to perform in front of an Event.
/// The command must be passed in the `on` method of the `AppComponent`
/// when calling `perform` method of the `Component`.
/// There is not a default conversion from `Event -> Cmd`, but it must be implmented by the user in the
/// `Component` in a match case.
#[derive(Debug, Eq, PartialEq, Copy, Clone, PartialOrd, Hash)]
pub enum Cmd {
    /// Describes a "user" typed a character
    Type(char),
    /// Describes a "cursor" movement, or a movement of another kind
    Move(Direction),
    /// An expansion of `Move` which defines the scroll. The step should be defined in props, if any.
    Scroll(Direction),
    /// Describes a movement with a position
    GoTo(Position),
    /// User submit field
    Submit,
    /// User "deleted" something
    Delete,
    /// User "cancelled" something; used to distinguish between Del and Canc
    Cancel,
    /// User toggled something
    Toggle,
    /// User changed something
    Change,
    /// A user defined amount of time has passed and the component should be updated
    Tick,
    /// A user defined command type. You won't find these kind of Command in the stdlib, but you can use them in your own components.
    Custom(&'static str),
    /// `None` won't do anything
    None,
}

/// Defines the 4 2D directions a cursor can move.
/// This may be used after a `Arrow::Up` event or if you want something more geeky
/// when using `WASD`
#[derive(Debug, Eq, PartialEq, Copy, Clone, PartialOrd, Hash)]
pub enum Direction {
    Down,
    Left,
    Right,
    Up,
}

/// Describes specific positions. Mostly used for exact cursor movement.
#[derive(Debug, Eq, PartialEq, Copy, Clone, PartialOrd, Hash)]
pub enum Position {
    Begin,
    End,
    At(usize),
}

// -- Command result

/// A command result describes the output of a [`Cmd`] performed on a Component.
/// It reports a "logical" change on the `Component`.
/// The [`AppComponent`](crate::component::AppComponent) then needs to handle this result and return a user defined `Msg` based on the value of the [`CmdResult`].
#[derive(Debug, PartialEq, Clone)]
#[allow(clippy::large_enum_variant)]
pub enum CmdResult {
    /// The component has changed state. The new state is reported.
    ///
    /// This implies the component has visually changes and needs to be redrawn.
    Changed(State),
    /// Command resulted in a submit action, this contains the submitted state.
    Submit(State),
    /// The command issues is unsupported for this component.
    ///
    /// This should basically be treated the same as [`NoChange`](CmdResult::NoChange), but may be useful for debugging.
    Invalid(Cmd),
    /// Custom result with a name and a state attached.
    Custom(&'static str, State),
    /// An array of Command results.
    Batch(Vec<CmdResult>),
    /// The component visually changed, but the state did not change.
    ///
    /// If state *did* change, always use [`Changed`](CmdResult::Changed) instead.
    Visual,
    /// Nothing changed, nothing needs to be done.
    NoChange,
}