Skip to main content

WidgetKind

Enum WidgetKind 

Source
pub enum WidgetKind {
Show 32 variants Text, Tail, List, Gauge, Bars, Histo, Spark, Chart, Table, Tabs, Block, Frame, LineGauge, Scatter, Sparkline, Map, Calendar, LogView, Heatmap, Treemap, Gantt, Diff, Logo, Blank, Rule, Sel, Input, Select, Filter, Facet, Slider, Check,
}

Variants§

§

Text

§

Tail

§

List

§

Gauge

§

Bars

§

Histo

§

Spark

§

Chart

§

Table

§

Tabs

§

Block

§

Frame

§

LineGauge

A thin single-line progress bar (ratatui LineGauge) — a compact gauge for tight grid cells. Same scalar source + -max as gauge.

§

Scatter

A braille scatter/line plot (ratatui Canvas) of a numeric series — a higher-resolution chart drawn with braille dots. -mode line|points.

§

Sparkline

A block-bar sparkline (ratatui Sparkline) of the numeric series — the classic fixed-height bar sparkline (distinct from spark’s braille line).

§

Map

A braille world map (ratatui Canvas + Map) plotting lon lat points parsed from the stream — geo scatter (IP geolocation, GPS traces). -res high|low.

§

Calendar

A month calendar (ratatui Monthly) for the current month, highlighting days that appear as YYYY-MM-DD in the stream (activity by day).

§

LogView

A level-colored log tail: like tail, but each line is tinted by its log level (ERROR/WARN/INFO/DEBUG) detected in the text — theme-aware.

§

Heatmap

A heatmap grid (GitHub-contribution-style): the numeric series laid out as colored cells, each cell’s shade scaled from the value across the palette.

§

Treemap

A treemap (slice-and-dice): tally/count_by pairs as proportional labeled rectangles filling the pane, colored across the palette.

§

Gantt

A Gantt/timeline: label start end lines drawn as horizontal bars on a shared time axis (min start → max end).

§

Diff

A diff-colored view: each line tinted by its leading char — + add (green), - remove (red), @ hunk (accent) — for git diff/patch streams.

The ratatui logo (braille wordmark), centered — a decorative splash.

§

Blank

A blank spacer (ratatui Clear) — occupies a grid cell without drawing, to open space in a layout.

§

Rule

A horizontal (or -dir vertical) divider rule in the theme accent.

§

Sel

An in-dashboard selection list over its own source (per-widget), with a moveable cursor. Its highlighted row is published as the control value .<path>.sel, readable from where/apply/tell/ask (SPEC §14). E.g. ps aux | arb with sel .ps { in } exposes .ps.sel = the current row.

§

Input

An editable text field. Its live value is bound into pipelines via apply .name (parse the value as a query pipeline) — the megafilter/map.

§

Select

An interactive fuzzy-select list over the stream (the fzf surface as a widget). Its presence puts the TUI in select mode: type to fuzzy-filter, arrows/Ctrl-N/P move the cursor, Tab marks, Enter emits the picked lines. -prompt/-header opts set the prompt line and a header above the list.

§

Filter

A text box whose value drives where match(.name) / apply — a labelled filter control (a specialised input).

§

Facet

A multi-select of candidate values (-opts {a b c}, else distinct stream -field values). Its value is the comma-joined selected set for where <field> in .name.

§

Slider

A numeric control (-min/-max/-step) whose value drives where <field> < .name; arrows/+/- adjust it.

§

Check

A boolean toggle (-label); its value is "1"/"0".

Implementations§

Source§

impl WidgetKind

Source

pub fn label(&self) -> &'static str

Source

pub fn is_control(&self) -> bool

Whether this kind is an interactive control (value lives in the input registry and drives apply/where … .name), not a stream view.

Trait Implementations§

Source§

impl Clone for WidgetKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for WidgetKind

Source§

impl Debug for WidgetKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for WidgetKind

Source§

impl PartialEq for WidgetKind

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WidgetKind

Auto Trait Implementations§

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more