Struct Builder

pub struct Builder { /* private fields */ }

Builder for creating root YieldProgress instances.

Implementations

impl Builder

pub fn new() -> Builder

Constructs a Builder.

The default values are:

• The yield function is basic_yield_now.
• The progress function does nothing.

The call site of this function is considered to be the yield point preceding the first actual yield point.

pub fn build(self) -> YieldProgress

Construct a new YieldProgress using the behaviors specified by this builder.

pub fn yield_using<Y, YFut>(self, function: Y) -> Self

where Y: for<'a> Fn(&'a YieldInfo<'a>) -> YFut + Send + Sync + 'static, YFut: Future<Output = ()> + Send + 'static,

Set the function which will be called in order to yield.

See basic_yield_now() for the default implementation used if this is not not set, and some information about what you might want to pass here instead.

pub fn progress_using<P>(self, function: P) -> Self

where P: for<'a> Fn(&'a ProgressInfo<'a>) + Send + Sync + 'static,

Set the function which will be called in order to report progress.

If this is called more than once, the previous function will be discarded (there is no list of callbacks). If this is not called, the default function used does nothing.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.