# Struct cargo::util::Progress

source ·

    pub struct Progress<'cfg> {
        state: Option<State<'cfg>>,
    }

Expand description

CLI progress bar.

The `Progress` object can be in an enabled or disabled state. When disabled, calling any of the methods to update it will not display anything. Disabling is typically done by the user with options such as `--quiet` or the `term.progress` config option.

There are several methods to update the progress bar and to cause it to update its display.

The bar will be removed from the display when the `Progress` object is dropped or `Progress::clear` is called.

The progress bar has built-in rate limiting to avoid updating the display too fast. It should usually be fine to call `Progress::tick` as often as needed, though be cautious if the tick rate is very high or it is expensive to compute the progress value.

## Fields§

§`state: Option<State<'cfg>>`

## Implementations§

source§

### impl<'cfg> Progress<'cfg>

source

#### pub fn with_style( name: &str, style: ProgressStyle, cfg: &'cfg Config ) -> Progress<'cfg>

Creates a new progress bar.

The first parameter is the text displayed to the left of the bar, such as “Fetching”.

The progress bar is not displayed until explicitly updated with one if its methods.

The progress bar may be created in a disabled state if the user has disabled progress display (such as with the `--quiet` option).

source

#### fn new_priv( name: &str, style: ProgressStyle, cfg: &'cfg Config ) -> Progress<'cfg>

source

#### pub fn disable(&mut self)

Disables the progress bar, ensuring it won’t be displayed.

source

#### pub fn is_enabled(&self) -> bool

Returns whether or not the progress bar is allowed to be displayed.

source

#### pub fn new(name: &str, cfg: &'cfg Config) -> Progress<'cfg>

Creates a new `Progress` with the `ProgressStyle::Percentage` style.

See `Progress::with_style` for more information.

source

#### pub fn tick(&mut self, cur: usize, max: usize, msg: &str) -> CargoResult<()>

Updates the state of the progress bar.

- `cur` should be how far along the progress is.
- `max` is the maximum value for the progress bar.
- `msg` is a small piece of text to display at the end of the progress bar. It will be truncated with `...` if it does not fit on the terminal.

This may not actually update the display if `tick` is being called too quickly.

source

#### pub fn tick_now(&mut self, cur: usize, max: usize, msg: &str) -> CargoResult<()>

Updates the state of the progress bar.

This is the same as `Progress::tick`, but ignores rate throttling and forces the display to be updated immediately.

This may be useful for situations where you know you aren’t calling `tick` too fast, and accurate information is more important than limiting the console update rate.

source

#### pub fn update_allowed(&mut self) -> bool

Returns whether or not updates are currently being throttled.

This can be useful if computing the values for calling the `Progress::tick` function may require some expensive work.

source

#### pub fn print_now(&mut self, msg: &str) -> CargoResult<()>

Displays progress without a bar.

The given `msg` is the text to display after the status message.

Example: `Downloading 61 crates, remaining bytes: 28.0 MB`

This does not have any rate limit throttling, so be careful about calling it too often.

source

#### pub fn clear(&mut self)

Clears the progress bar from the console.

## Auto Trait Implementations§

§

### impl<'cfg> !RefUnwindSafe for Progress<'cfg>

§

### impl<'cfg> !Send for Progress<'cfg>

§

### impl<'cfg> !Sync for Progress<'cfg>

§

### impl<'cfg> Unpin for Progress<'cfg>

§

### impl<'cfg> !UnwindSafe for Progress<'cfg>

## 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.

§

### impl<T> Instrument for T

§

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

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

#### 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.

§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

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

§

#### 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>,

§

#### 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.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### 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
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

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

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 128 bytes