Struct Builder

pub struct Builder<T, E> { /* private fields */ }

Construct the settings around how a Refreshed should be created and updated.

Implementations

impl<T, E> Builder<T, E>

where T: Send + Sync + 'static, E: Send + Sync + 'static,

pub fn duration(&mut self, duration: Duration) -> &mut Self

Set the duration for refreshing. Default value: 60 seconds.

pub fn error(&mut self, error: impl Fn(&E) + Send + Sync + 'static) -> &mut Self

What should we do with error values produced while refreshing? Default: no action.

pub fn success( &mut self, success: impl Fn(&T) + Send + Sync + 'static, ) -> &mut Self

What should we do with success values produced while refreshing? Default: no action.

pub fn exit(&mut self, exit: impl Fn() + Send + Sync + 'static) -> &mut Self

What should we do when the refresh loop exits? Default: debug level log message.

pub async fn try_build<Fut, MkFut>( &self, mk_fut: MkFut, ) -> Result<Refreshed<T, E>, E>

where Fut: Future<Output = Result<T, E>> + Send + 'static, MkFut: FnMut(bool) -> Fut + Send + 'static,

Construct a Refreshed value from the given initialization function, which may fail.

The closure is provided false on the first call, and true on subsequent refresh calls.

impl<T> Builder<T, Infallible>

where T: Send + Sync + 'static,

pub async fn build<Fut, MkFut>(&self, mk_fut: MkFut) -> Refreshed<T, Infallible>

where Fut: Future<Output = T> + Send + 'static, MkFut: FnMut(bool) -> Fut + Send + 'static,

Construct a Refreshed value from the given initialization function

impl<T, E> Builder<T, E>

where T: Send + Sync + 'static, E: Debug + Send + Sync + 'static,

pub fn log_errors(&mut self) -> &mut Self

Turn on default error logging when an error occurs.

Trait Implementations

impl<T, E> Default for Builder<T, E>

fn default() -> Self

Returns the “default value” for a type.