Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

Represents a progress bar

Implementations

impl ProgressBar

pub fn new( id: &str, unique_name: Option<&str>, len: ProgressValue, msg: &str, failure_message: &str, progress_type: ProgressType, progress_action: ProgressAction, ) -> Self

Create a new progress bar This will begin reporting the progress bar to the log

Arguments

• id - The ID of the progress bar
• unique_name - The unique name of the mod this progress bar is for, pass None if the progress bar doesn’t know what mod it’s for
• len - The length of the progress bar
• msg - The message of the progress bar
• failure_message - The message to show if the progress bar fails
• progress_type - The type of progress bar
• progress_action - The action this progress bar is reporting

Returns

The new progress bar Note that if this is dropped without calling finish, it will be considered a failure, so make sure to call finish!

pub fn inc(&mut self, amount: ProgressValue)

Increment the progress bar This will throttle the amount of times the progress bar can be incremented, so an increment may not emit a log line This is done to prevent spamming small increments

pub fn set_msg(&self, msg: &str)

Set the message of the progress bar

pub fn finish(&mut self, success: bool, msg: &str)

Finish the progress bar

This will emit a log line with the final message of the progress bar This function should always be called when the progress bar is done, as a drop will result in a failure

Arguments

• success - Whether the progress bar succeeded or failed
• msg - The message of the progress bar, this will be ignored if the progress bar failed, and will instead use the failure message passed initially

Trait Implementations

impl Drop for ProgressBar

fn drop(&mut self)

Executes the destructor for this type.