Struct NotcursesBuilder 

pub struct NotcursesBuilder { /* private fields */ }

A Notcurses builder.

Implementations

impl NotcursesBuilder

constructors

pub fn new() -> Self

Returns a new default NotcursesBuilder, without banners.

pub fn build(self) -> Result<Notcurses>

Returns a Notcurses instance.

impl NotcursesBuilder

methods (chainable)

pub fn log_level(self, log_level: LogLevel) -> Self

Sets the log level.

pub fn margins(self, top: u32, right: u32, bottom: u32, left: u32) -> Self

Sets the margins.

pub fn margin_top(self, top: u32) -> Self

Sets the top margin.

pub fn margin_right(self, right: u32) -> Self

Sets the right margin.

pub fn margin_bottom(self, bottom: u32) -> Self

Sets the bottom margin.

pub fn margin_left(self, left: u32) -> Self

Sets the left margin.

pub fn drain_input(self, drain: bool) -> Self

If true, Input may be freely dropped.

This ought be provided when the program does not intend to handle input. Otherwise, input can accumulate in internal buffers, eventually preventing Notcurses from processing terminal messages.

pub fn inhibit_set_locale(self, inhibit: bool) -> Self

If true, wont call setlocale().

pub fn no_alternate_screen(self, no_alternate: bool) -> Self

If true, wont enter alternate mode.

pub fn no_clear_bitmaps(self, no_clear: bool) -> Self

If true, wont try to clear any preexisting bitmaps.

pub fn no_font_changes(self, no_font_changes: bool) -> Self

If true, wont modify the font.

pub fn no_quit_sig_handlers(self, no_quit: bool) -> Self

If true, wont handle SIGINT, SIGSEGV, SIGABRT nor SIGQUIT.

pub fn no_winch_sig_handler(self, no_winch: bool) -> Self

If true, wont handle SIGWINCH.

pub fn preserve_cursor(self, preserve: bool) -> Self

If true, will initializes the CLI plane’s virtual cursor to match the physical cursor at context creation time.

pub fn scrolling(self, scrolling: bool) -> Self

If true, will prepare the CLI plane in scrolling mode.

pub fn cli_mode(self, cli_mode: bool) -> Self

A shortcut for setting the following options together: no_alternate_screen, no_clear_bitmaps, preserve_cursor & scrolling.

pub fn suppress_banners(self, suppress_banners: bool) -> Self

If true, wont print banners.

Trait Implementations

impl Clone for NotcursesBuilder

fn clone(&self) -> NotcursesBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NotcursesBuilder

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

Formats the value using the given formatter.

impl Default for NotcursesBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Copy for NotcursesBuilder