Skip to main content

InlineStrategy

Enum InlineStrategy 

Source
pub enum InlineStrategy {
    ScrollRegion,
    OverlayRedraw,
    Hybrid,
}
Expand description

Inline mode rendering strategy.

Variants§

§

ScrollRegion

Use scroll regions (DECSTBM) to anchor UI while logs scroll. More efficient but less portable (muxes may misbehave).

§

OverlayRedraw

Overlay redraw: no scroll region. The runtime’s TerminalWriter batches log lines, erases the UI rows, streams the lines with ordinary line feeds so the whole screen scrolls them into scrollback, then redraws the UI (bottom-anchored UI; a top-anchored UI keeps only the newest line). Works on any terminal; costs one UI redraw per batch.

§

Hybrid

Hybrid: the same DECSTBM scroll region as ScrollRegion but without synchronized-output brackets, verified at startup by the DECSTBM self-test (caps_probe::probe_scroll_region); a terminal that ignores the region is switched to OverlayRedraw before the first frame.

Implementations§

Source§

impl InlineStrategy

Source

pub fn select(caps: &TerminalCapabilities) -> Self

Select the strategy from capabilities, in this order:

  • inside a terminal multiplexer (tmux/screen/zellij/WezTerm mux): OverlayRedraw (muxes may not handle scroll regions correctly);
  • scroll region and synchronized output: ScrollRegion;
  • scroll region without synchronized output: Hybrid;
  • otherwise OverlayRedraw.

The runtime then runs the DECSTBM self-test for ScrollRegion and Hybrid and falls back to OverlayRedraw when the terminal does not honour the region (TerminalWriter::set_scroll_region_verified).

Trait Implementations§

Source§

impl Clone for InlineStrategy

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 InlineStrategy

Source§

impl Debug for InlineStrategy

Source§

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

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

impl Default for InlineStrategy

Source§

fn default() -> Self

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

impl Eq for InlineStrategy

Source§

impl PartialEq for InlineStrategy

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 InlineStrategy

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.