Struct Timer 

pub struct Timer { /* private fields */ }

Fluent native GPUI component for rendering Liora timer.

Implementations

impl Timer

pub fn count_up(elapsed: Duration) -> Self

Sets the count up value used by the component.

pub fn count_down(duration: Duration, elapsed: Duration) -> Self

Sets the count down value used by the component.

pub fn new( direction: TimerDirection, elapsed: Duration, duration: Option<Duration>, ) -> Self

Creates Timer initialized from the supplied direction, elapsed, and duration.

pub fn id(self, id: impl Into<SharedString>) -> Self

Assigns a stable element id used by GPUI state, hit testing, and automated interaction tests.

pub fn elapsed(self, elapsed: Duration) -> Self

Sets the elapsed value used by the component.

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

Sets the duration value used by the component.

pub fn direction(self, direction: TimerDirection) -> Self

Selects the layout or animation direction.

pub fn countup(self) -> Self

Sets the countup value used by the component.

pub fn countdown(self) -> Self

Sets the countdown value used by the component.

pub fn display_unit(self, unit: TimerUnit) -> Self

Sets the display unit value used by the component.

pub fn format(self, format: TimerFormat) -> Self

Sets the format displayed or consumed by the component.

pub fn clock_format(self) -> Self

Sets the clock format value used by the component.

pub fn show_unit(self, show: bool) -> Self

Configures whether unit is visible in the rendered component.

pub fn title(self, title: impl Into<SharedString>) -> Self

Sets the primary title text displayed by the component.

pub fn prefix(self, prefix: impl Into<SharedString>) -> Self

Sets the prefix value used by the component.

pub fn suffix(self, suffix: impl Into<SharedString>) -> Self

Sets the suffix value used by the component.

pub fn compact(self) -> Self

Sets the compact value used by the component.

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

Sets the running value used by the component.

pub fn start(self) -> Self

Sets the start value used by the component.

pub fn paused(self) -> Self

Sets the paused value used by the component.

pub fn tick_interval(self, interval: Duration) -> Self

Sets the tick interval value used by the component.

pub fn snapshot(&self) -> TimerSnapshot

Performs the snapshot operation used by this component.

pub fn elapsed_as(&self, unit: TimerUnit) -> f64

Performs the elapsed as operation used by this component.

pub fn remaining_as(&self, unit: TimerUnit) -> Option<f64>

Performs the remaining as operation used by this component.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl IntoElement for Timer

type Element = Component<Timer>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Timer

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.