ProgressTracker

Struct ProgressTracker 

Source
pub struct ProgressTracker { /* private fields */ }
Expand description

进度追踪器

线程安全的进度追踪器,支持多个订阅者。

§Example

use unistore_progress::ProgressTracker;

let tracker = ProgressTracker::new(100);
tracker.advance(10);
tracker.set_message("处理中...");
assert_eq!(tracker.current(), 10);

Implementations§

Source§

impl ProgressTracker

Source

pub fn new(total: u64) -> Self

创建新的进度追踪器

§Arguments
  • total - 总任务数
§Panics

如果 total 为 0

Source

pub fn with_config(total: u64, config: ProgressConfig) -> Self

使用自定义配置创建进度追踪器

Source

pub fn total(&self) -> u64

获取总数

Source

pub fn current(&self) -> u64

获取当前完成数

Source

pub fn percentage(&self) -> f64

获取完成百分比(0.0 - 100.0)

Source

pub fn is_finished(&self) -> bool

是否已完成

Source

pub fn elapsed(&self) -> Duration

获取已用时间

Source

pub fn advance(&self, delta: u64)

增加进度

§Arguments
  • delta - 增加的数量
Source

pub fn set(&self, value: u64)

设置进度到指定值

Source

pub fn set_message(&self, message: impl Into<String>)

设置进度消息

Source

pub fn finish(&self)

标记为完成

Source

pub fn subscribe(&self) -> Receiver<ProgressEvent>

订阅进度更新

Source

pub fn snapshot(&self) -> ProgressEvent

获取当前快照

Trait Implementations§

Source§

impl Debug for ProgressTracker

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more