notcurses 3.6.0

A high level Rust wrapper for the notcurses C library
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

// norcurses::macros
//
//!
//

/// Prints to a plane, similarly as [`print!`].
///
/// `Plane`.[`putstr`] using the [`format!`] syntax.
///
/// [`putstr`]: crate::plane::Plane#method.putstr
///
/// Optionally renders with `+render` as first argument.
///
/// # Example
/// ```
/// # use notcurses::*;
/// # fn main() -> NotcursesResult<()> {
/// # let mut nc = Notcurses::new_cli()?;
/// # let mut plane = Plane::new(&mut nc)?;
/// # plane.set_scrolling(true);
/// assert_eq![12, putstr!(plane, "hello\nworld\n")?];
/// putstr!(plane, "formatted text: {:?}\n", (0, 1.0, "two") )?;
/// putstr!(+render plane, "renders afterwards = {}", true)?;
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! putstr {
    ($plane:expr, $($args:tt)*) => {
        ({
            let res = $plane.putstr(&format![$($args)*])?;
            Ok(res)
        }) as $crate::NotcursesResult<u32>
    };
    (+render $plane:expr, $($args:tt)*) => {
        ({
            let res = $plane.putstr(&format![$($args)*])?;
            $plane.render()?;
            Ok(res)
        }) as $crate::NotcursesResult<u32>
    };

}

/// Prints to a plane, with a new line, similarly as [`println!`].
///
/// `Plane`.[`putstrln`] using the [`format!`] syntax.
///
/// [`putstrln`]: crate::plane::Plane#method.putstrln
///
/// Optionally renders with `+render` as first argument.
///
/// # Example
/// ```
/// # use notcurses::*;
/// # fn main() -> NotcursesResult<()> {
/// # let mut nc = Notcurses::new_cli()?;
/// # let mut plane = Plane::new(&mut nc)?;
/// # plane.set_scrolling(true);
/// assert_eq![12, putstrln!(plane, "hello world")?];
/// putstrln!(plane, "formatted text: {:?}", (0, 1.0, "two") )?;
/// putstrln!(+render plane)?;
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! putstrln {
    ($plane:expr) => {
        ({
            let res = $plane.putln()?;
            Ok(res)
        }) as $crate::NotcursesResult<u32>
    };
    ($plane:expr, $($args:tt)*) => {
        ({
            let res = $plane.putstrln(&format![$($args)*])?;
            Ok(res)
        }) as $crate::NotcursesResult<u32>
    };
    (+render $plane:expr) => {
        ({
            let res = $plane.putln()?;
            $plane.render()?;
            Ok(res)
        }) as $crate::NotcursesResult<u32>
    };
    (+render $plane:expr, $($args:tt)*) => {
        ({
            let res = $plane.putstrln(&format![$($args)*])?;
            $plane.render()?;
            Ok(res)
        }) as $crate::NotcursesResult<u32>
    };
}