Struct libnotcurses_sys::NcOptionsBuilder

pub struct NcOptionsBuilder { /* private fields */ }

Builder object for NcOptions.

Implementations

impl NcOptionsBuilder

constructors

pub fn new() -> Self

New NcOptionsBuilder.

pub fn from_options(options: &NcOptions) -> Self

New builder from pre-existing options.

pub fn build(self) -> NcOptions

Finishes the building and returns NcOptions.

impl NcOptionsBuilder

methods (chainable)

pub fn log_level(self, log_level: NcLogLevel) -> 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.

See NcFlag::DrainInput.

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

If true, wont call setlocale().

See NcFlag::InhibitSetLocale.

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

If true, wont enter alternate mode.

See NcFlag::NoAlternateScreen.

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

If true, wont try to clear any preexisting bitmaps.

See NcFlag::NoClearBitmaps.

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

If true, wont modify the font.

See NcFlag::NoFontChanges.

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

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

See NcFlag::NoQuitSigHandlers.

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

If true, wont handle SIGWINCH.

See NcFlag::NoWinchSigHandler.

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.

See NcFlag::PreserveCursor.

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

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

See NcFlag::Scrolling.

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.

See NcFlag::CliMode.

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

If true, wont print banners.

See NcFlag::SuppressBanners.

impl NcOptionsBuilder

methods (settable)

pub fn set_log_level(&mut self, log_level: NcLogLevel)

Sets the log level.

pub fn set_margins(&mut self, top: u32, right: u32, bottom: u32, left: u32)

Sets the margins.

pub fn set_margin_top(&mut self, top: u32)

Sets the top margin.

pub fn set_margin_right(&mut self, right: u32)

Sets the right margin.

pub fn set_margin_bottom(&mut self, bottom: u32)

Sets the bottom margin.

pub fn set_margin_left(&mut self, left: u32)

Sets the left margin.

pub fn set_drain_input(&mut self, drain: bool)

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.

See NcFlag::DrainInput.

pub fn set_inhibit_set_locale(&mut self, inhibit: bool)

If true, wont call setlocale().

See NcFlag::InhibitSetLocale.

pub fn set_no_alternate_screen(&mut self, no_alternate: bool)

If true, wont enter alternate mode.

See NcFlag::NoAlternateScreen.

pub fn set_no_clear_bitmaps(&mut self, no_clear: bool)

If true, wont try to clear any preexisting bitmaps.

See NcFlag::NoClearBitmaps.

pub fn set_no_font_changes(&mut self, no_font_changes: bool)

If true, wont modify the font.

See NcFlag::NoFontChanges.

pub fn set_no_quit_sig_handlers(&mut self, no_quit: bool)

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

See NcFlag::NoQuitSigHandlers.

pub fn set_no_winch_sig_handler(&mut self, no_winch: bool)

If true, wont handle SIGWINCH.

See NcFlag::NoWinchSigHandler.

pub fn set_preserve_cursor(&mut self, preserve: bool)

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

See NcFlag::PreserveCursor.

pub fn set_scrolling(&mut self, scrolling: bool)

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

See NcFlag::Scrolling.

pub fn set_cli_mode(&mut self, cli_mode: bool)

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

See NcFlag::CliMode.

pub fn set_suppress_banners(&mut self, suppress_banners: bool)

If true, wont print banners.

See NcFlag::SuppressBanners.

impl NcOptionsBuilder

query methods

pub fn get_margins(&self) -> (u32, u32, u32, u32)

Returns the (top, right, bottom, left) margins.

pub fn get_log_level(&self) -> NcLogLevel

Returns the log level.

pub fn is_drain_input(&self) -> bool

Returns true if it has the DrainInput flag set.

pub fn is_inhibit_set_locale(&self) -> bool

Returns true if it has the InhibitSetLocale flag set.

pub fn is_no_alternate_screen(&self) -> bool

Returns true if it has the NoAlternateScreen flag set.

pub fn is_no_clear_bitmaps(&self) -> bool

Returns true if it has the NoClearBitmaps flag set.

pub fn is_no_font_changes(&self) -> bool

Returns true if it has the NoFontChanges flag set.

pub fn is_no_quit_sig_handlers(&self) -> bool

Returns true if it has the NoQuitSigHandlers flag set.

pub fn is_no_winch_sig_handler(&self) -> bool

Returns true if it has the NoWinchSigHandler flag set.

pub fn is_preserve_cursor(&self) -> bool

Returns true if it has the PreserveCursor flag set.

pub fn is_scrolling(&self) -> bool

Returns true if it has the Scrolling flag set.

pub fn is_cli_mode(&self) -> bool

Returns true if it has the CliMode flag set.

pub fn is_suppress_banners(&self) -> bool

Returns true if it has the SuppressBanners flag set.

Trait Implementations

impl Clone for NcOptionsBuilder

fn clone(&self) -> NcOptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NcOptionsBuilder

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

Formats the value using the given formatter.

impl Default for NcOptionsBuilder

fn default() -> NcOptionsBuilder

Returns the “default value” for a type.

impl From<&NcOptionsBuilder> for NcOptions

fn from(builder: &NcOptionsBuilder) -> Self

Converts to this type from the input type.

impl From<&mut NcOptionsBuilder> for NcOptions

fn from(builder: &mut NcOptionsBuilder) -> Self

Converts to this type from the input type.

impl From<&mut notcurses_options> for NcOptionsBuilder

fn from(options: &mut NcOptions) -> Self

Converts to this type from the input type.

impl From<&notcurses_options> for NcOptionsBuilder

fn from(options: &NcOptions) -> Self

Converts to this type from the input type.

impl From<NcOptionsBuilder> for NcOptions

fn from(builder: NcOptionsBuilder) -> NcOptions

Converts to this type from the input type.

impl From<notcurses_options> for NcOptionsBuilder

fn from(options: NcOptions) -> NcOptionsBuilder

Converts to this type from the input type.

impl Copy for NcOptionsBuilder