Struct Group 

pub struct Group<'a, F> { /* private fields */ }

A group of futures displayed as multi-line progress with per-task annotations.

Each future in the group occupies its own terminal line showing a spinner, optional progress bar and a message. Lines are removed as futures complete.

Tasks are configured fluently and handed to push(), either as a bare future (via Into<Task<...>>) or as a Task configured with with_label, with_messages and with_progress.

Group implements Stream. Each time a future completes, the stream yields its output.

Example

use std::time::Duration;
use futures_lite::{StreamExt, future};
use strides::future::{FutureExt, Group};
use strides::spinner;

future::block_on(async {
    let mut group = Group::new(spinner::styles::DOTS_3);
    group.push(async_io::Timer::after(Duration::from_secs(1)).with_label("fast"));
    group.push(async_io::Timer::after(Duration::from_secs(3)).with_label("slow"));
    group.for_each(|_| {}).await;
});

Implementations

impl<'a, F> Group<'a, F>

where F: Future,

pub fn new<S: Into<Theme<'a>>>(theme: S) -> Self

Create a new group with the given theme.

Accepts a Theme or a bare Spinner (converted via Into). When the theme includes a Bar it is used to render per-task progress for tasks configured via Task::with_progress.

pub fn with_spinner_style(self, spinner_style: Style) -> Self

Apply spinner_style to the spinner character on every line.

pub fn with_annotation_style(self, annotation_style: Style) -> Self

Apply annotation_style to each task’s prefix.

pub fn with_elapsed_time(self, with_elapsed_time: bool) -> Self

When true, prepend [Xs] (seconds since the group was first polled) to each line.

pub fn push(&mut self, task: impl Into<Task<'a, F>>)

Add a task to the group.

Accepts either a bare future (lifted into a Task via From) or a Task configured with with_label, with_messages and/or with_progress.

Trait Implementations

impl<F> Stream for Group<'_, F>

where F: Future + Unpin,

type Item = <F as Future>::Output

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.