Struct kbar::KBar

pub struct KBar { /* private fields */ }

The struct for handling progress bars

Example:

use kbar::{KBar, BarType};
use std::thread::sleep;
use std::time::Duration;

fn main() {
    // using crossterm, this will create a kbar at 0,0
    // without crossterm, this is the only way to create a bar
    let mut kbar = KBar::new(BarType::Bar, true, true, 20);

    for x in 0..1000 {
        // get the percentage complete as a decimal
        let percentage_decimal = x as f32 / 1000.0;
        // scale the percentage from 0..1 to 0..100 and convert to a u8
        let percent = (percentage_decimal * 100.0) as u8;
        // update the kbar
        kbar.update(percent);
        // draw the kbar
        kbar.draw();
        // delay for 10ms, making this run in 10 seconds
        sleep(Duration::from_millis(10));
    }
}

crossterm specific creation

Creating at a location

use kbar::{KBar, BarType};

KBar::new_at(0, 0, BarType::Bar, true, true, 20);

Creating at the cursor’s current location

use kbar::{KBar, BarType};

KBar::new_at_cursor(BarType::Bar, true, true, 20);

Implementations

impl KBar

pub fn new(
bar_type: BarType,
color: bool,
show_percent: bool,
bar_length: u16
) -> Self

create a new progress bar when using crossterm

parameters

bar_type: the type of bar to display color: if it should output in color show_percent: if it should show the percentage next to the bar bar_length: How long the bar should be

pub fn new_at(
x: u16,
y: u16,
bar_type: BarType,
color: bool,
show_percent: bool,
bar_length: u16
) -> Self

Create a new bar using crossterm at a location

parameters

x: the x location to put the bar (0 is the left) y: the y location to put the bar (0 is the top) bar_type: the type of bar to display color: if it should output in color show_percent: if it should show the percentage next to the bar bar_length: How long the bar should be

pub fn new_at_cursor(
bar_type: BarType,
color: bool,
show_percent: bool,
bar_length: u16
) -> Result<Self, String>

Creates a new bar using crossterm at the cursor’s current position

parameters

bar_type: the type of bar to display color: if it should output in color show_percent: if it should show the percentage next to the bar bar_length: How long the bar should be

pub fn update(&mut self, percent: u8)

Update the bar’s progress

Parameters

percent: the new percentage (0 to 100)

pub fn draw(&mut self)

Draw the bar at its set location

pub fn is_complete(&self) -> bool

Trait Implementations

impl Clone for KBar

fn clone(&self) -> KBar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KBar

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

Formats the value using the given formatter.

impl Default for KBar

fn default() -> Self

Creates a bar using default values