[go: up one dir, main page]

crossterm 0.4.1

An crossplatform terminal library for manipulating terminals.
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//!
//! Examples of actions that could be performed with te cursor.
//!

extern crate crossterm;
use self::crossterm::cursor::{cursor, TerminalCursor};
use self::crossterm::Screen;

/// Set the cursor to position X: 10, Y: 5 in the terminal.
pub fn goto() {
    // Get the cursor
    let screen = Screen::default();
    let mut cursor = cursor(&screen);
    // Set the cursor to position X: 10, Y: 5 in the terminal
    cursor.goto(10, 5);
}

/// get the cursor position
pub fn pos() {
    // Get the cursor
    let screen = Screen::default();
    let mut cursor = cursor(&screen);
    // get the cursor position.
    let (x, y) = cursor.pos();
}

/// Move the cursor 3 up | demonstration.
pub fn move_up() {
    // Get the cursor
    let screen = Screen::default();
    let mut cursor = cursor(&screen);

    // Move the cursor to position 3 times to the up in the terminal
    cursor.move_up(10);
}

/// Move the cursor 3 to the right | demonstration.
pub fn move_right() {
    let screen = Screen::default();
    let mut cursor = cursor(&screen);
    // Move the cursor to position 3 times to the right in the terminal
    cursor.move_right(3);
}

/// Move the cursor 3 down | demonstration.
pub fn move_down() {
    let screen = Screen::default();
    let mut cursor = cursor(&screen);
    // Move the cursor to position 3 times to the down in the terminal
    cursor.move_down(3);
}

/// Move the cursor 3 to the left | demonstration.
pub fn move_left() {
    let screen = Screen::default();
    let mut cursor = cursor(&screen);

    // Move the cursor to position 3 times to the left in the terminal
    cursor.move_left(3);
}

///// Print character at X: 10 Y: 5 | demonstration.
//pub fn print() {
//    let context = Context::new();
//
//    // To print an some displayable content on an certain position.
//
//    // Get the cursor
//    let mut cursor = cursor(&context);
//    // Set the cursor to position X: 10, Y: 5 in the terminal
//    cursor.goto(10, 5);
//    // Print the @ symbol at position X: 10, Y: 5 in the terminal
//    print!("@");
//    // Rust is line buffered inorder to print at an certain position we need to clear the buffer first.
//    use std;
//    use std::io::Write;
//    std::io::stdout().flush();
//
//    /* Because the above method is a little to much code,
//       you can use the `print()` method for printing an value at an certain position in the terminal.
//
//       Crossterm provides method chaining so that the above points can be inlined.
//    */
//
//    cursor.goto(10, 5).print("@");
//}

/// Save and reset cursor position | demonstration..
pub fn safe_and_reset_position() {
    let screen = Screen::default();
    let mut cursor = cursor(&screen);

    // Goto X: 5 Y: 5
    cursor.goto(5, 5);
    // Safe cursor position: X: 5 Y: 5
    cursor.save_position();
    // Goto X: 5 Y: 20
    cursor.goto(5, 20);
    // Print at X: 5 Y: 20.
    println!("Yea!");
    // Reset back to X: 5 Y: 5.
    cursor.reset_position();
    // Print Back at X: 5 Y: 5.
    println!("Back");

    println!()
}

/// Hide cursor display | demonstration.
pub fn hide_cursor() {
    let screen = Screen::default();
    let mut cursor = cursor(&screen);
    cursor.hide();
}

/// Show cursor display | demonstration.
pub fn show_cursor() {
    let screen = Screen::default();
    let mut cursor = cursor(&screen);
    cursor.show();
}

/// Show cursor display, only works on certain terminals.| demonstration
pub fn blink_cursor() {
    let screen = Screen::default();
    let mut cursor = cursor(&screen);
    cursor.blink(false);
    cursor.blink(false);
}