libnotcurses_sys/notcurses/mod.rs
1//! `Nc`
2
3// total: 55
4// ---------------------------------------------------
5// (X) 1 : wont do
6// (…) 4 : TODO / WIP
7//
8// (f) 36 : unsafe ffi function exported by bindgen
9// (w) 0 : safely wrapped ffi function
10// (r) 15 : static function manually reimplemented
11//
12// (m) 42 : method implemented
13//
14// (t) 13 : unit test done for the function
15// (T) 0 : unit test done also for the method
16// ---------------------------------------------------
17// fm notcurses_at_yx
18// rm notcurses_bottom
19// rm notcurses_canbraille
20// rmt notcurses_canchangecolor
21// rmt notcurses_canfade
22// fmt notcurses_canopen_images
23// fmt notcurses_canopen_videos
24// rmt notcurses_cansextant
25// rmt notcurses_cantruecolor
26// rmt notcurses_canutf8
27// fm notcurses_check_pixel_support
28//~f notcurses_core_init
29// fm notcurses_cursor_disable
30// fm notcurses_cursor_enable
31// f notcurses_cursor_yx
32// fmt notcurses_debug
33// fm notcurses_default_background
34// fm notcurses_default_foreground
35//~f notcurses_detected_terminal
36// fmt notcurses_drop_planes
37// fm notcurses_get
38// fm notcurses_getvec
39// fmt notcurses_init
40// fm notcurses_inputready_fd
41// fm notcurses_lex_blitter
42// fm notcurses_lex_margins
43// fm notcurses_lex_scalemode
44// fm notcurses_linesigs_disable
45// fm notcurses_linesigs_enable
46// fm notcurses_mice_enable
47// rm notcurses_mice_disable
48// fm notcurses_osversion
49// fm notcurses_palette_size
50// fm notcurses_refresh
51// rm notcurses_render
52// fm notcurses_stats
53// fm notcurses_stats_alloc
54// fm notcurses_stats_reset
55// fm notcurses_stdplane
56// fm notcurses_stdplane_const
57// fmt notcurses_stop
58// fm notcurses_str_blitter
59// fm notcurses_str_scalemode
60// fm notcurses_supported_styles
61// rm notcurses_top
62//X notcurses_ucs32_to_utf8 (not needed in rust)
63// fmt notcurses_version
64// fm notcurses_version_components
65// rmt notcurses_align
66// rm notcurses_canpixel
67// rm notcurses_get_blocking
68// rm notcurses_get_nblock
69//~r notcurses_stddim_yx // multiple mutable references errors
70//~r notcurses_stddim_yx_const //
71// rm notcurses_term_dim_yx
72
73mod methods;
74
75pub(crate) mod helpers;
76pub(crate) mod options;
77pub(crate) mod reimplemented;
78
79#[cfg(test)]
80mod test;
81
82pub use options::{NcFlag, NcOptions, NcOptionsBuilder};
83
84/// Notcurses state for a given terminal, composed of [`NcPlane`]s.
85///
86/// It's built atop the terminfo abstraction layer to provide reasonably
87/// portable vivid character displays.
88///
89/// [`NcPlane`]: crate::NcPlane
90pub type Nc = crate::c_api::ffi::notcurses;