Struct notcurses_options

#[repr(C)]
pub struct notcurses_options {
    pub termtype: *const c_char,
    pub loglevel: ncloglevel_e,
    pub margin_t: c_uint,
    pub margin_r: c_uint,
    pub margin_b: c_uint,
    pub margin_l: c_uint,
    pub flags: u64,
}

Configuration for notcurses_init().

Fields

termtype: *const c_char

The name of the terminfo database entry describing this terminal. If NULL, the environment variable TERM is used. Failure to open the terminal definition will result in failure to initialize notcurses.

loglevel: ncloglevel_e

Progressively higher log levels result in more logging to stderr. By default, nothing is printed to stderr once fullscreen service begins.

margin_t: c_uint

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

margin_r: c_uint

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

margin_b: c_uint

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

margin_l: c_uint

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

flags: u64

General flags; see NCOPTION_*. This is expressed as a bitfield so that future options can be added without reshaping the struct. Undefined bits must be set to 0.

Implementations

impl notcurses_options

constructors

pub fn builder() -> NcOptionsBuilder

Returns a default Nc options builder.

pub fn to_builder(&self) -> NcOptionsBuilder

Returns a builder object from the current Nc options.

pub fn new() -> Self

New NcOptions.

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

New NcOptions, with margins.

pub fn with_flags(flags: NcFlag) -> Self

New NcOptions, with flags.

pub fn with_all_options( loglevel: NcLogLevel, trbl_margins: Option<(u32, u32, u32, u32)>, flags: NcFlag, ) -> NcOptions

New NcOptions, with flags

impl notcurses_options

methods

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

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

pub fn 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 Debug for notcurses_options

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

Formats the value using the given formatter.

impl Default for notcurses_options

fn default() -> Self

Returns the “default value” for a 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<notcurses_options> for NcOptionsBuilder

fn from(options: NcOptions) -> NcOptionsBuilder

Converts to this type from the input type.

impl Hash for notcurses_options

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for notcurses_options

fn cmp(&self, other: &notcurses_options) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for notcurses_options

fn eq(&self, other: &notcurses_options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for notcurses_options

fn partial_cmp(&self, other: &notcurses_options) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for notcurses_options

impl StructuralPartialEq for notcurses_options