Skip to main content

Status

Struct Status 

Source
pub struct Status { /* private fields */ }
Expand description

A spinner + message status indicator. Mirrors rich.status.Status.

Implementations§

Source§

impl Status

Source

pub fn new(message: impl Into<String>) -> Self

A status showing message with the default dots spinner, styled status.spinner (green in the default theme).

Source

pub fn spinner(self, name: &str) -> Self

Choose the spinner animation by name (default dots).

Source

pub fn spinner_style(self, style: impl Into<StyleType>) -> Self

Style applied to the spinner frame (default status.spinner).

Source

pub fn speed(self, speed: f64) -> Self

Set the spinner animation speed multiplier (default 1.0).

Source

pub fn update( &mut self, status: Option<&str>, spinner: Option<&str>, spinner_style: Option<StyleType>, speed: Option<f64>, )

Port of Status.update. None (and, as upstream, a zero speed) leaves a field unchanged. A new spinner name builds a fresh spinner; otherwise the current one is updated in place, a speed change continuing from its current frame.

Source

pub fn renderable(&self) -> &Spinner

The underlying spinner. Mirrors upstream’s Status.renderable.

Trait Implementations§

Source§

impl Renderable for Status

Source§

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

Source§

fn measure(&self, _console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. The default assumes the renderable fills the available width (e.g. Panel, Table); Text overrides it with its content width so the top-level print path can shrink to fit. Port of __rich_measure__ / Measurement.get.
Source§

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. The shrink stands in for upstream’s _collect_renderables, which joins printed str/Text values; other upstream renderables render at the full width, so one whose output pads to the width it is given (Syntax’s background) returns false.

Auto Trait Implementations§

§

impl !Freeze for Status

§

impl !RefUnwindSafe for Status

§

impl !Sync for Status

§

impl Send for Status

§

impl Unpin for Status

§

impl UnsafeUnpin for Status

§

impl UnwindSafe for Status

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.