Struct libnotcurses_sys::c_api::ncprogbar

#[repr(C)]
pub struct ncprogbar { /* fields omitted */ }

Implementations

impl ncprogbar

NcProgBar Methods

pub fn new<'a>(plane: &mut NcPlane) -> &'a mut Self

New NcProgBar.

Takes ownership of the plane, which will be destroyed by destroy(). The progress bar is initially at 0%.

pub fn with_options<'a>(
    plane: &mut NcPlane,
    options: &NcProgBarOptions
) -> &'a mut Self

New NcProgBar. Expects an NcProgBarOptions struct.

C style function: ncprogbar_create().

pub fn destroy(&mut self)

Destroy the progress bar and its underlying ncplane.

C style function: ncprogbar_destroy().

pub fn plane(&mut self) -> &mut NcPlane

Return a reference to the ncprogbar’s underlying ncplane.

C style function: ncprogbar_plane().

pub fn progress(&self) -> f64

Get the progress bar’s completion, an f64 on [0, 1].

C style function: ncprogbar_progress().

pub fn set_progress(&mut self, progress: f64) -> NcResult<()>

Sets the progress bar’s completion, an 0 <= f64 <= 1.

Returns NcIntResult::ERR if progress is < 0 || > 1.

C style function: ncprogbar_set_progress().

Trait Implementations

impl Debug for ncprogbar

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

Formats the value using the given formatter.