Struct Notcurses 

pub struct Notcurses { /* private fields */ }

Notcurses state for a given terminal, composed of Planes.

There can only be a single Notcurses instance per thread at any given moment.

Implementations

impl Notcurses

pub fn is_initialized() -> bool

Returns true if there’s already a notcurses instance initialized in this thread.

impl Notcurses

constructors & deconstructors.

pub fn new() -> Result<Self>

Returns a new Notcurses context.

pub fn with_banners() -> Result<Self>

Returns a new Notcurses context, with banners.

pub fn new_cli() -> Result<Self>

Returns a new Notcurses context in CLI mode.

pub fn with_banners_cli() -> Result<Self>

Returns a new Notcurses context in CLI mode, with banners.

pub fn with_nc<F, R>(&self, f: F) -> R

where F: FnOnce(&Nc) -> R,

Safely access the Nc reference.

pub fn with_nc_mut<F, R>(&self, f: F) -> R

where F: FnOnce(&mut Nc) -> R,

Safely access the mutable Nc reference.

impl Notcurses

constructors for other types.

pub fn cli_plane(&self) -> Result<Plane>

pub fn new_palette(&mut self) -> Palette

impl Notcurses

event methods

pub fn refresh(&self) -> Result<(u32, u32)>

Refreshes the physical screen to match what was last rendered (i.e., without reflecting any changes since the last call to render).

Returns the current screen geometry (y, x).

This is primarily useful if the screen is externally corrupted, or if a resize] event has been read and you’re not yet ready to render.

pub fn mice_enable(&self, input: MiceEvents) -> Result<()>

Enables receiving the provided mice events.

pub fn mice_disable(&self) -> Result<()>

Disables receiving the mice events.

pub fn get_event(&self) -> Result<Input>

Waits for an event, blocking.

pub fn poll_event(&self) -> Result<Input>

Tries to get an event, non blocking.

impl Notcurses

general query methods

pub fn size(&self) -> Size

Returns the terminal size.

pub fn geometry_best(&self) -> PlaneGeometry

Returns the terminal geometry with the best resolution blitter available, using the following rules of graceful degradation:

Pixel > Sextant > Quadrant > Half > Ascii.

pub fn geometry_try(&self, blitter: Blitter) -> Option<PlaneGeometry>

Returns the terminal geometry using the requested blitter, if available.

pub fn geometry_first(&self, blitters: &[Blitter]) -> Option<PlaneGeometry>

Returns the first terminal geometry available from the provided list.

pub fn geometries_all(&self, blitters: &[Blitter]) -> Vec<PlaneGeometry>

Returns all the availeble terminal geometries from the provided list.

pub fn visual_geometry(&self, visual: &Visual) -> Result<VisualGeometry>

Returns the visual geometry of a visual.

pub fn capabilities(&self) -> Capabilities

Returns the capabilities of the terminal.

pub fn supported_styles(&self) -> Style

Returns an Style with the supported curses-style attributes.

The attribute is only indicated as supported if the terminal can support it together with color.

pub fn default_background(&self) -> Option<Rgb>

Returns the default background color, if it is known.

pub fn default_foreground(&self) -> Option<Rgb>

Returns the default foreground color, if it is known.

pub fn version() -> String

Returns a human-readable string describing the running notcurses version.

pub fn version_components() -> (u32, u32, u32, u32)

Returns the running notcurses version components (major, minor, patch, tweak).

pub fn accountname() -> String

Returns the name of the user under which we are running.

pub fn hostname() -> String

Returns the name of the local hostname.

pub fn osversion() -> String

Returns the name of the detected OS version.

pub fn detected_terminal(&self) -> String

Returns the name of the detected terminal.

impl Notcurses

settings methods

pub fn cursor_disable(&self) -> Result<()>

Disables the terminal’s cursor.

pub fn cursor_enable(&self, position: impl Into<Position>) -> Result<()>

Enables the terminal’s cursor, if available, placing it at position.

pub fn leave_alternate_screen(&mut self) -> Result<()>

Leaves the alternate screen.

pub fn enter_alternate_screen(&mut self) -> Result<()>

Enters the alternate screen, if available.

Entering the alternate screen turns off scrolling for the CLI plane.

pub fn signals_disable(&mut self) -> Result<()>

Disables signals originating from the terminal’s line discipline, i.e. SIGINT (^C), SIGQUIT (^), and SIGTSTP (^Z). They are enabled by default.

pub fn signals_enable(&mut self) -> Result<()>

Restores signals originating from the terminal’s line discipline, i.e. SIGINT (^C), SIGQUIT (^), and SIGTSTP (^Z), if disabled.

impl Notcurses

statistics methods

pub fn statistics(&mut self) -> Statistics

Allocates a Statistics object.

pub fn statistics_reset(&mut self, stats: Statistics)

Resets all cumulative statistics.

Immediate ones, such as fbbytes, are not reset.

pub fn statistics_update(&mut self, stats: Statistics)

Acquires an atomic snapshot of the notcurses statistics.

Trait Implementations

impl Debug for Notcurses

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.