Struct TerminalView

Source
pub struct TerminalView { /* private fields */ }
Expand description

Scrollable terminal-log widget with static lines and/or streaming events.

This is a log viewer, not a PTY or ANSI parser. It is always keyboard focusable; selection controls only pointer selection. The default history cap is 2,000 complete lines and matching is ASCII-case-insensitive. Its overlay scrollbar supports captured thumb dragging and centered track clicks; wheel, track, and drag all use the same bounded history offset.

§Examples

use ailloli_ui_widgets::controls::{TerminalLine, TerminalView};
let terminal = TerminalView::new().line(TerminalLine::success("finished"));
let _ = terminal;

Implementations§

Source§

impl TerminalView

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).width(24.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).height(24.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_width(12.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_width(32.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_height(12.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_height(32.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).margin(4.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).padding(4.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_basis(20.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::{style::AlignItems, IconId};
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).align_self(AlignItems::Center);
let _ = widget;
Source§

impl TerminalView

Source

pub fn new() -> Self

Creates an empty terminal with default style and interaction settings.

The initial size is 680 x 260 logical pixels, cursor/selection/scrollbar behavior is enabled, and vertical scroll starts at zero.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new();
let _ = terminal;
Source

pub fn line(self, line: TerminalLine) -> Self

Appends one initial complete line.

§Examples
use ailloli_ui_widgets::controls::{TerminalLine, TerminalView};
let terminal = TerminalView::new().line(TerminalLine::prompt("$ "));
let _ = terminal;
Source

pub fn lines(self, lines: impl IntoIterator<Item = TerminalLine>) -> Self

Extends initial complete lines in iterator order.

Existing lines are preserved and the history cap is applied during build.

§Examples
use ailloli_ui_widgets::controls::{TerminalLine, TerminalView};
let terminal = TerminalView::new().lines([TerminalLine::new("one"), TerminalLine::new("two")]);
let _ = terminal;
Source

pub fn event(self, event: TerminalEvent) -> Self

Appends one initial event to apply after initial lines.

§Examples
use ailloli_ui_widgets::controls::{TerminalEvent, TerminalView};
let terminal = TerminalView::new().event(TerminalEvent::stdout_chunk(1, "building"));
let _ = terminal;
Source

pub fn events(self, events: impl IntoIterator<Item = TerminalEvent>) -> Self

Extends initial events in iterator order without sorting by sequence.

§Examples
use ailloli_ui_widgets::controls::{TerminalEvent, TerminalView};
let terminal = TerminalView::new().events([TerminalEvent::clear(1), TerminalEvent::status(2, "ready")]);
let _ = terminal;
Source

pub fn event_source(self, source: Rc<dyn TerminalEventSource>) -> Self

Installs a pull source, replacing any previous source.

It is synchronously drained during layout, paint, and input; sources should therefore return promptly and avoid blocking UI work.

§Examples
use std::rc::Rc;
use ailloli_ui_widgets::controls::{TerminalEventBuffer, TerminalView};
let terminal = TerminalView::new().event_source(Rc::new(TerminalEventBuffer::new()));
let _ = terminal;
Source

pub fn event_buffer(self, buffer: TerminalEventBuffer) -> Self

Installs a cloneable shared FIFO event buffer as the source.

Keep a clone before moving the buffer when later producers need to push.

§Examples
use ailloli_ui_widgets::controls::{TerminalEventBuffer, TerminalView};
let writer = TerminalEventBuffer::new();
let terminal = TerminalView::new().event_buffer(writer.clone());
let _ = terminal;
Source

pub fn max_history(self, max_history: usize) -> Self

Sets the maximum number of retained complete lines.

Oldest complete lines are removed first. Zero rejects complete appended lines; an unfinished nonempty chunk may still be visible as the partial line.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().max_history(500);
let _ = terminal;
Source

pub fn search_query(self, query: impl Into<Binding<String>>) -> Self

Sets the static or reactive exact search query.

Empty queries produce no matches; whitespace is not trimmed.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().search_query("error".to_string());
let _ = terminal;
Source

pub fn search_case_sensitive(self, case_sensitive: bool) -> Self

Selects exact-case or ASCII-case-insensitive matching.

The default is false (ASCII-case-insensitive).

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().search_case_sensitive(true);
let _ = terminal;
Source

pub fn selection(self, selection: TerminalSelection) -> Self

Sets the initial selection; line bounds are clamped during build/paint.

The selection still paints when pointer selection is disabled.

§Examples
use ailloli_ui_widgets::controls::{TerminalSelection, TerminalView};
let terminal = TerminalView::new().selection(TerminalSelection::lines(0, 2));
let _ = terminal;
Source

pub fn terminal_style(self, style: TerminalViewStyle) -> Self

Replaces style and resets explicit layout width/height to its defaults.

Call width/height builders after this method to override the style sizes.

§Examples
use ailloli_ui_widgets::controls::{TerminalView, TerminalViewStyle};
let terminal = TerminalView::new().terminal_style(TerminalViewStyle::default());
let _ = terminal;
Source

pub fn initial_scroll_y(self, scroll_y: f32) -> Self

Sets requested initial vertical scroll offset in logical pixels.

f32::max normalizes negative values and NaN to zero; positive infinity is retained until scroll metrics clamp it during layout.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().initial_scroll_y(120.0);
let _ = terminal;
Source

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

Enables or disables cursor painting; enabled by default.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().show_cursor(false);
let _ = terminal;
Source

pub fn cursor_line(self, cursor_line: usize) -> Self

Sets the zero-based line after which the cursor is painted.

Without this call the last buffer line is used. An out-of-range index paints no cursor.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().cursor_line(3);
let _ = terminal;
Source

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

Enables or disables pointer-drag selection updates.

This does not change focusability, keyboard scrolling, or a supplied initial selection. The default is true.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().selectable(false);
let _ = terminal;
Source

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

Enables scrollbar reservation, painting, and pointer interaction. This is enabled by default.

Scrolling remains available when this is false.

§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().scrollbars(false);
let _ = terminal;

Trait Implementations§

Source§

impl Default for TerminalView

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<A: 'static> IntoView<A> for TerminalView

Source§

fn into_view(self) -> View<A>

Builds the retained component and preserves flex/size metadata.

Source§

impl LayoutExt for TerminalView

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

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> 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, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,