Struct loading_bar::loading_bar::LoadingBar

pub struct LoadingBar { /* private fields */ }

Implementations

impl LoadingBar

these methods/functions are used to auomatically generate and or update the loading bar

Note: because I don’t fully understand threads and mutexes, you can’t acces the loading bar once it’s been used in one of these methods.

pub fn auto_run(
    time_in_seconds: u16,
    len: u16,
    start: u16,
    color: Option<Color>,
    start_pos: (u16, u16)
)

pub fn auto_run_change(
    change: Vec<Option<Color>>,
    time_in_seconds: u16,
    len: u16,
    start: u16,
    start_pos: (u16, u16)
)

pub fn auto_run_from(loading_bar: LoadingBar, time_in_seconds: u16)

pub fn auto_run_change_points(
    change: HashMap<u16, Option<Color>>,
    time_in_seconds: u16,
    len: u16,
    start: u16,
    start_pos: (u16, u16)
)

pub fn auto_run_from_change(
    loading_bar: LoadingBar,
    change: Vec<Option<Color>>,
    time_in_seconds: u16
)

pub fn auto_run_from_change_points<T, U>(
    loading_bar: LoadingBar,
    change: HashMap<T, U>,
    time_in_seconds: u16,
    type_change: Types
) where
    T: Copy + Debug,
    u16: From<T>,
    f32: From<T>,
    U: Copy + Debug + Send + 'static,
    Option<Color>: From<U>, 

impl LoadingBar

These methods are for basic loading bar creation and manipulation.

pub fn new(len: u16, color: Option<Color>, start_pos: (u16, u16)) -> LoadingBar

this is used to create a new loading bar

Arguments Len: Length of the loading bar

Arguments Color: Color of the loading bar, if None, it will be white

Arguments Pos: Position of the loading bar in the terminal using (x, y)

pub fn change_pos(&mut self, pos: (u16, u16))

this is used to change the position of the loading bar in the terminal using (x, y)

Arguments Pos: Position of the loading bar in the terminal using (x, y)

it will cleear the old position and move to the new position (but not print anything)

pub fn change_pos_print(&mut self, pos: (u16, u16))

this is the same as change_pos but it also prints the the loading bar

pub fn advance(&mut self)

pub fn advance_print(&mut self)

pub fn advance_by(&mut self, index: u16)

pub fn advance_by_print(&mut self, index: u16)

pub fn change_character_type(&mut self, character: char)

pub fn change_last_character(&mut self, character: char)

pub fn change_bracket_color(&mut self, color: Option<Color>)

pub fn change_bracket_color_print(&mut self, color: Option<Color>)

pub fn change_last_character_print(&mut self, character: char)

pub fn change_character_type_print(&mut self, character: char)

pub fn advance_by_percent(&mut self, percentage: f32)

pub fn advance_by_percent_print(&mut self, percentage: f32)

pub fn change_color(&mut self, color: Option<Color>)

pub fn change_color_print(&mut self, color: Option<Color>)

pub fn change(&mut self, map: HashMap<&str, LoadingBarOptions>, print: bool)

pub fn print(&self)

Trait Implementations

impl Clone for LoadingBar

fn clone(&self) -> LoadingBar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoadingBar

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

Formats the value using the given formatter.

impl Display for LoadingBar

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

Formats the value using the given formatter.