Struct ScrinLoader 

pub struct ScrinLoader<'a> { /* private fields */ }

A themeable Scrin/Aisling loader player as a normal Scrin widget.

Implementations

impl<'a> ScrinLoader<'a>

pub fn new(kind: LoaderKind, progress: f32) -> Self

Creates a loader widget with progress clamped to 0.0..=1.0.

pub fn progress(&self) -> f32

Returns the clamped progress.

pub fn tick(self, tick: u64) -> Self

Sets the animation tick.

pub fn label(self, label: impl Into<Cow<'a, str>>) -> Self

Sets the loader label.

pub fn unit(self, unit: impl Into<Cow<'a, str>>) -> Self

Sets the loader unit.

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

Enables or disables fraction display.

pub fn palette(self, palette: AislingPalette) -> Self

Sets the palette used for Scrin/Aisling accent and gradient colors.

pub fn block(self, block: Block<'a>) -> Self

Adds a block around the loader.

pub fn render_with_interaction( &self, frame: &mut Frame<'_>, id: impl Into<WidgetId>, area: Rect, )

Renders into a Scrin frame and registers a loader status hit region.

Trait Implementations

impl<'a> Clone for ScrinLoader<'a>

fn clone(&self) -> ScrinLoader<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ScrinLoader<'a>

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

Formats the value using the given formatter.

impl PartialEq for ScrinLoader<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Widget for ScrinLoader<'_>

fn render(&self, buf: &mut Buffer, area: Rect)