Struct libnotcurses_sys::c_api::ffi::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

NcOptions Constructors

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: impl Into<NcFlag>) -> Self

New NcOptions, with flags.

pub fn with_all_options(
    loglevel: impl Into<NcLogLevel>,
    margin_t: u32,
    margin_r: u32,
    margin_b: u32,
    margin_l: u32,
    flags: impl Into<NcFlag>
) -> Self

New NcOptions, with all the options.

Arguments

• loglevel

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

• margin_t, margin_r, margin_b, margin_l

  Desirable margins (top, right, bottom, left).

  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. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

• flags

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

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 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, 

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<notcurses_options> for notcurses_options

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<notcurses_options> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for notcurses_options

impl StructuralEq for notcurses_options

impl StructuralPartialEq for notcurses_options