pub struct CardPayload {
pub value: String,
pub unit: Option<String>,
pub icon: Option<String>,
pub subtitle: Option<String>,
pub delta_percent: Option<f64>,
pub delta_label: Option<String>,
pub sparkline: Option<Vec<f64>>,
}Expand description
Summary card payload. Renders as:
┌──────────────────────────────────────────┐
│ TITLE [icon] │ ← title row (from Widget)
│ │
│ USD 12,438.20 │ ← unit (sm, left) + value (lg, right)
│ │
│ This month ↑ 12.3% vs last month │ ← subtitle + growth
└──────────────────────────────────────────┘Build with CardPayload::new + the chained setters; pass to
WidgetPayload::Card.
Fields§
§value: StringFormatted primary value, e.g. “12,438.20” or “12.4K”. Use
humanize_number for the K/M/B/T compaction.
unit: Option<String>Optional unit / context label shown on the left side of the value row, e.g. “USD”, “rows”, “today”.
icon: Option<String>Optional Lucide icon name (e.g. “dollar-sign”, “shopping-cart”). Rendered via the data-lucide attribute the wrapper already initializes.
subtitle: Option<String>Optional caption below the value, e.g. “This month”.
delta_percent: Option<f64>Percentage delta vs. the previous period, signed:
+12.3 = up 12.3%, -4.1 = down 4.1%. The renderer picks
the arrow + color from the sign.
delta_label: Option<String>Optional comparison label, e.g. “vs last month”.
sparkline: Option<Vec<f64>>Optional trend trail — a flat series of N points the
renderer plots as a fade-right sparkline under the value.
X is implicit (evenly spaced); Y autoscales between
min/max. Pair with growth(...) so the pill matches the
trail visually. Keep the series small (7–30 points) —
anything denser turns into noise at sparkline scale.
Implementations§
Source§impl CardPayload
impl CardPayload
Sourcepub fn new(value: impl Into<String>) -> Self
pub fn new(value: impl Into<String>) -> Self
New card with just a primary value. Caller picks the format
— strings stay as-is, numbers should be pre-humanized with
humanize_number / format_thousands.
pub fn unit(self, unit: impl Into<String>) -> Self
pub fn icon(self, icon: impl Into<String>) -> Self
pub fn subtitle(self, subtitle: impl Into<String>) -> Self
Sourcepub fn growth(self, current: f64, previous: f64) -> Self
pub fn growth(self, current: f64, previous: f64) -> Self
Compute the delta automatically from current + previous raw
numbers. Skips the delta when previous is zero (no baseline
to grow from) or non-finite — the renderer just won’t show
the growth row in that case.
Sourcepub fn delta(self, percent: f64, label: impl Into<String>) -> Self
pub fn delta(self, percent: f64, label: impl Into<String>) -> Self
Explicit delta percent (signed) + label. Use when you’ve computed the percentage yourself or want a custom label.
Sourcepub fn delta_label(self, label: impl Into<String>) -> Self
pub fn delta_label(self, label: impl Into<String>) -> Self
Standalone label for the delta — pairs with Self::growth
for the common case “auto-compute the percent but customize
the comparison label” (e.g. "vs prior 30d").
Sourcepub fn sparkline(self, points: impl IntoIterator<Item = f64>) -> Self
pub fn sparkline(self, points: impl IntoIterator<Item = f64>) -> Self
Attach a trend trail rendered as a fade-right sparkline
under the value. Pass 7–30 raw numbers (daily totals,
hourly counts, etc.); the renderer autoscales and colors
the stroke to match Self::delta_percent’s sign.
Trait Implementations§
Source§impl Clone for CardPayload
impl Clone for CardPayload
Source§fn clone(&self) -> CardPayload
fn clone(&self) -> CardPayload
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CardPayload
impl Debug for CardPayload
Source§impl<'de> Deserialize<'de> for CardPayload
impl<'de> Deserialize<'de> for CardPayload
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for CardPayload
impl RefUnwindSafe for CardPayload
impl Send for CardPayload
impl Sync for CardPayload
impl Unpin for CardPayload
impl UnsafeUnpin for CardPayload
impl UnwindSafe for CardPayload
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<A, B, T> HttpServerConnExec<A, B> for Twhere
B: Body,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);