Struct Shimmer 

pub struct Shimmer { /* private fields */ }

A brightness crest sweeping across one line of cells.

Pure phase arithmetic on the shared clock, like a gradient spin: the crest travels a track padded on both sides so it fully enters and exits the text instead of popping at an edge, then wraps and sweeps again. Cells away from the crest keep the authored style, its shoulders brighten, and the peak lifts further and paints bold. <text> consumes this declaratively through the shimmer property — see crate::Props::shimmer.

Implementations

impl Shimmer

pub fn new(now: Duration, period: Duration, length: u16) -> Self

Places the crest at now: one sweep across length cells (plus runway) per period.

Examples found in repository

examples/footers.rs (line 508)

fn draw_working(frame: &mut Frame, x: u16, y: u16, scene: &Scene) {
	let hint = scene.charset.icon(Icon::Cancellable);
	let length = width_of(hint)
		.saturating_add(1)
		.saturating_add(width_of(WORKING));
	let shimmer = Shimmer::new(scene.elapsed, SHIMMER_PERIOD, length);
	let mut column = x;
	draw_shimmer(frame, &mut column, x, y, scene.right_edge(), hint, shimmer, ink(CYAN));
	draw_shimmer(frame, &mut column, x, y, scene.right_edge(), " ", shimmer, ink(GREEN));
	draw_shimmer(frame, &mut column, x, y, scene.right_edge(), WORKING, shimmer, ink(GREEN));
}

/// The pi flavor of the working line: the spinner and timer lead, then
/// the shimmering narration — the band below carries no brand segment.
fn draw_working_spin(frame: &mut Frame, x: u16, y: u16, scene: &Scene) {
	let mut column = frame.put(x, y, scene.spinner(), ink(GREEN));
	column = frame.put(column, y, " ", ink(GREEN));
	column = frame.put(column, y, &scene.timer(), ink(MUTED));
	column = frame.put(column, y, " ", ink(MUTED));
	let shimmer = Shimmer::new(scene.elapsed, SHIMMER_PERIOD, width_of(WORKING));
	let start = column;
	draw_shimmer(frame, &mut column, start, y, scene.right_edge(), WORKING, shimmer, ink(GREEN));
}

examples/chat/demo.rs (line 1366)

	fn draw_working(frame: &mut Frame, y: u16, elapsed: Duration, hint: &str) {
		if y >= frame.size().height || frame.size().width < 4 {
			return;
		}
		let start = u16::from(frame.size().width >= 50);
		let mut column = start;
		let length = xutf::graphemes_str(WORKING_MESSAGE)
			.count()
			.saturating_add(xutf::graphemes_str(hint).count())
			.saturating_add(1);
		let length = u16::try_from(length).unwrap_or(u16::MAX);
		let shimmer = Shimmer::new(elapsed, SHIMMER_PERIOD, length);
		let right = frame.size().width.saturating_sub(1);
		draw_shimmer(frame, &mut column, start, y, right, hint, shimmer, ink(CYAN));
		draw_shimmer(frame, &mut column, start, y, right, " ", shimmer, ink(GREEN));
		draw_shimmer(frame, &mut column, start, y, right, WORKING_MESSAGE, shimmer, ink(GREEN));
	}

pub fn pick<T>(&self, cell: u16, low: T, mid: T, high: T) -> T

Picks one of three values by crest intensity at cell (zero-based from the text start): low off the crest, mid on its shoulders, high at the peak. The seam for custom palettes — Shimmer::style_at is this with the dim/base/bold derivation.

Examples found in repository

examples/chat/demo.rs (line 111)

fn draw_shimmer(
	frame: &mut Frame,
	column: &mut u16,
	start: u16,
	y: u16,
	right: u16,
	text: &str,
	shimmer: Shimmer,
	high: Style,
) {
	for grapheme in xutf::graphemes_str(text) {
		if *column >= right {
			return;
		}
		let style = shimmer.pick(*column - start, ink(FAINT), ink(MUTED), high);
		let next = frame.put(*column, y, grapheme, style);
		if next == *column {
			return;
		}
		*column = next;
	}
}

examples/footers.rs (line 544)

fn draw_shimmer(
	frame: &mut Frame,
	column: &mut u16,
	start: u16,
	y: u16,
	right: u16,
	text: &str,
	shimmer: Shimmer,
	high: Style,
) {
	for grapheme in xutf::graphemes_str(text) {
		if *column >= right {
			return;
		}
		let style = shimmer.pick(*column - start, ink(FAINT), ink(MUTED), high);
		let next = frame.put(*column, y, grapheme, style);
		if next == *column {
			return;
		}
		*column = next;
	}
}

pub fn style_at(&self, cell: u16, base: Style) -> Style

The style for cell (zero-based from the text start). Shimmer is additive: base rests unchanged off the crest, so a shimmering line matches its non-shimmering appearance except under the sweep. An RGB foreground lifts one-fifth toward white on the shoulders and two-fifths plus bold at the peak; a default or indexed foreground carries no channel data, so only the peak’s bold shows.

Trait Implementations

impl Clone for Shimmer

fn clone(&self) -> Shimmer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Shimmer

impl Debug for Shimmer

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

Formats the value using the given formatter.