Struct MultiProgressState 

pub struct MultiProgressState { /* private fields */ }

State for the MultiProgress component.

Implementations

impl MultiProgressState

pub fn new() -> Self

Creates a new empty MultiProgress state.

pub fn with_max_visible(self, max: usize) -> Self

Sets the maximum number of visible items.

pub fn with_auto_remove(self, auto_remove: bool) -> Self

Sets whether to auto-remove completed items.

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the title.

pub fn with_percentages(self, show: bool) -> Self

Sets whether to show percentages.

pub fn add(&mut self, id: impl Into<String>, label: impl Into<String>) -> bool

Adds a new progress item.

Returns true if the item was added (id was unique).

pub fn items(&self) -> &[ProgressItem]

Returns all items.

pub fn len(&self) -> usize

Returns the number of items.

pub fn is_empty(&self) -> bool

Returns true if there are no items.

pub fn completed_count(&self) -> usize

Returns the number of completed items.

pub fn failed_count(&self) -> usize

Returns the number of failed items.

pub fn active_count(&self) -> usize

Returns the number of active items.

pub fn overall_progress(&self) -> f32

Returns the overall progress (average of all items).

pub fn find(&self, id: &str) -> Option<&ProgressItem>

Finds an item by ID.

pub fn find_mut(&mut self, id: &str) -> Option<&mut ProgressItem>

Finds a mutable item by ID.

pub fn remove(&mut self, id: &str) -> bool

Removes an item by ID.

pub fn clear(&mut self)

Clears all items.

pub fn max_visible(&self) -> usize

Returns the maximum visible items.

pub fn set_max_visible(&mut self, max: usize)

Sets the maximum visible items.

pub fn scroll_offset(&self) -> usize

Returns the scroll offset.

pub fn set_scroll_offset(&mut self, offset: usize)

Sets the scroll offset.

pub fn title(&self) -> Option<&str>

Returns the title.

pub fn set_title(&mut self, title: Option<String>)

Sets the title.

pub fn show_percentages(&self) -> bool

Returns whether percentages are shown.

pub fn set_show_percentages(&mut self, show: bool)

Sets whether to show percentages.

pub fn auto_remove_completed(&self) -> bool

Returns whether auto-remove is enabled.

pub fn set_auto_remove_completed(&mut self, auto_remove: bool)

Sets whether to auto-remove completed items.

pub fn is_focused(&self) -> bool

Returns true if the multi-progress is focused.

pub fn set_focused(&mut self, focused: bool)

Sets the focus state.

pub fn is_disabled(&self) -> bool

Returns true if the multi-progress is disabled.

pub fn set_disabled(&mut self, disabled: bool)

Sets the disabled state.

pub fn with_disabled(self, disabled: bool) -> Self

Sets the disabled state using builder pattern.

pub fn handle_event(&self, event: &Event) -> Option<MultiProgressMessage>

Maps an input event to a multi-progress message.

pub fn dispatch_event(&mut self, event: &Event) -> Option<MultiProgressOutput>

Dispatches an event, updating state and returning any output.

pub fn update( &mut self, msg: MultiProgressMessage, ) -> Option<MultiProgressOutput>

Updates the multi-progress state with a message, returning any output.

Trait Implementations

impl Clone for MultiProgressState

fn clone(&self) -> MultiProgressState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiProgressState

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

Formats the value using the given formatter.

impl Default for MultiProgressState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MultiProgressState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MultiProgressState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MultiProgressState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MultiProgressState