Struct BarSpectrum 

pub struct BarSpectrum { /* private fields */ }

Levels as columns rising from the bottom, as cava and a graphic equaliser show a spectrum: each band (from dsp::bands, lowest first, falling under dsp::Falloff for cava’s look) a bar bar_width cells wide, gap cells apart, its top in eighths of a cell.

• mirror draws the bands twice, the low ones in the middle and the high ones at both edges (cava’s mirrored layout); stereo puts one channel on each side, the left reversed.
• Levels are scaled from 0 to the loudest band (or range); a level outside is drawn at the end it passes, a NaN as 0.
• The bars are centred in the width they are given. When they do not fit, the gaps go first, then the bars narrow to a cell, then neighbouring bands share a column (the louder shown).
• It fills the height it is given (a Layout region, an intuiTUIve node) unless height is set; given none, it is 8 rows. In ASCII, each bar is #s to the nearest whole cell.

use rich::Console;
use rich_ext::chart::BarSpectrum;

let console = Console::builder().width(7).color_system(None).build();
let bars = BarSpectrum::new([1.0, 0.5, 0.25]).range(1.0).height(2);
assert_eq!(console.render_export(&bars), " █     \n █ █ ▄ \n");
// Mirrored: the low bands in the middle.
let console = Console::builder().width(11).color_system(None).build();
let mirrored = bars.mirror(true);
assert_eq!(console.render_export(&mirrored), "    █ █    \n▄ █ █ █ █ ▄\n");

Implementations

impl BarSpectrum

pub fn new(bands: impl IntoIterator<Item = f64>) -> Self

A bar per band of bands, lowest frequency first.

pub fn stereo( left: impl IntoIterator<Item = f64>, right: impl IntoIterator<Item = f64>, ) -> Self

Two channels, mirrored: left’s bands from the middle out to the left edge, right’s from the middle to the right edge.

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

Draw the bands twice, the low ones in the middle (default false). A stereo spectrum is always mirrored.

pub fn range(self, max: f64) -> Self

The level of a full bar (default: the loudest band). Bars start at 0.

pub fn bar_width(self, cells: usize) -> Self

Cells a bar is wide (default 1, at least 1).

pub fn gap(self, cells: usize) -> Self

Cells between bars (default 1).

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

The bars’ style: a theme key or a definition (default chart.bar).

pub fn charset(self, charset: Charset) -> Self

Which glyphs to draw with (default Charset::Auto: blocks, or ASCII on an ASCII-only console).

pub fn height(self, rows: usize) -> Self

Height in rows (at most 65535), whatever height it is given.

pub fn bands(&self) -> (&[f64], Option<&[f64]>)

The bands, as given: the left channel’s (or the only one), and the right channel’s for a stereo spectrum.

Trait Implementations

impl AccessibleText for BarSpectrum

Bar spectrum, 16 bands, mirrored, levels from 0 to 0.8, then the loudest band (Loudest: band 3 of 16, 0.8); a stereo one says each channel’s.

fn accessible_text(&self, _width: usize) -> String

The content as plain lines, laid out for width where layout matters.

impl Clone for BarSpectrum

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BarSpectrum

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

Formats the value using the given formatter.

impl Draw for BarSpectrum

fn draw( &self, console: &Console, options: &ConsoleOptions, screen: &mut Screen, rect: Rect, )

Draw into rect of screen, rendered with options (its width and height are the rectangle’s): the cells screen.write_lines(rect, &console.render_lines(self, options, false)) would give.

impl PartialEq for BarSpectrum

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

Equality operator ==.

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

Inequality operator !=.

impl Renderable for BarSpectrum

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

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

The (minimum, maximum) cell width this renderable wants. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.

impl StructuralPartialEq for BarSpectrum