Struct Progressive 

pub struct Progressive<T> { /* private fields */ }

Typed content paired with a shared lifecycle and monotonic revision.

The revision changes only when lifecycle or content actually changes. It can therefore be used as a cheap cache key by expensive renderers.

Implementations

impl<T> Progressive<T>

pub fn pending(content: T) -> Self

Creates pending progressive content.

pub fn running(content: T) -> Self

Creates running progressive content.

pub fn complete(content: T) -> Self

Creates completed progressive content.

pub fn failed(content: T, reason: impl Into<SharedString>) -> Self

Creates failed progressive content.

pub fn content(&self) -> &T

Returns the current typed content.

pub fn state(&self) -> &ProgressState

Returns the current lifecycle.

pub fn revision(&self) -> u64

Returns the monotonic content/lifecycle revision.

pub fn start(&mut self)

Moves pending or terminal work into the running state.

pub fn finish(&mut self)

Marks work complete.

pub fn fail(&mut self, reason: impl Into<SharedString>)

Marks work failed with a user-visible reason.

impl Progressive<String>

pub fn new() -> Self

Creates empty running text.

pub fn done(text: impl Into<String>) -> Self

Creates text that is already complete.

pub fn text(&self) -> &str

Returns the accumulated text.

pub fn append(&mut self, chunk: &str)

Appends a non-empty chunk and advances the revision.

pub fn replace(&mut self, text: impl Into<String>)

Replaces text when the replacement differs and advances the revision.

pub fn is_streaming(&self) -> bool

Returns whether the text is still arriving.

Trait Implementations

impl<T: Clone> Clone for Progressive<T>

fn clone(&self) -> Progressive<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Progressive<T>

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

Formats the value using the given formatter.

impl Default for Progressive<String>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq> Eq for Progressive<T>

impl<T: PartialEq> PartialEq for Progressive<T>

fn eq(&self, other: &Progressive<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Progressive<T>