libzui 0.0.3

A Terminal UI Library, Written in Rust
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

//! # Cursor manipulation in the terminal
//!
// ## Example
//
// ```rust
// use zui::term::Terminal;
// use zui::term::cursor::TCursor;
// use std::io;
//
// fn main() {
//     let mut stdout = io::stdout();
//     let mut terminal = Terminal::new(&mut stdout).unwrap();
//     terminal.set_cursor_to(1, 1).unwrap();
//
//     terminal.show_cursor().unwrap();
//     terminal.hide_cursor().unwrap();
//
//     terminal.blinking_block().unwrap();
//     terminal.steady_block().unwrap();
//     terminal.blinking_underline().unwrap();
//     terminal.steady_underline().unwrap();
//     terminal.blinking_bar().unwrap();
//     terminal.steady_bar().unwrap();
// }
// ```
//
// Author: Abhinav Chavali
// Date: October 8th, 2021
// Updated: October 13th, 2021

// imports
use std::io;

/// Cursor states
#[derive(Debug)]
pub enum Cursor {
    Default,
    Hidden,
    BlinkingBlock,
    Block,
    BlinkingUnderline,
    Underline,
    BlinkingBar,
    Bar,
}

type IoResult = io::Result<()>;
/// Cursor methods (implemented on Terminal)
pub trait TCursor {
    fn set_cursor_to(&mut self, x_pos: u16, y_pos: u16) -> IoResult;

    fn get_cursor(&self) -> io::Result<(u16, u16)>;

    fn show_cursor(&mut self) -> IoResult;

    fn hide_cursor(&mut self) -> IoResult;

    fn blinking_block(&mut self) -> IoResult;

    fn steady_block(&mut self) -> IoResult;

    fn blinking_underline(&mut self) -> IoResult;

    fn steady_underline(&mut self) -> IoResult;

    fn blinking_bar(&mut self) -> IoResult;

    fn steady_bar(&mut self) -> IoResult;

    fn reset_cursor(&mut self) -> IoResult;
}

// TODO: Fix these tests please.
// #[cfg(test)]
// mod tests {
//     use crate::term::Terminal;
//     use std::io;
//
//     #[test]
//     fn test_cursor_set() {
//         let output = io::stdout();
//         let mut my_term = Terminal::new(output).unwrap();
//         my_term.set_cursor(25, 57);
//         println!("This is a test. {:?}", my_term);
//     }
// }