Skip to main content

InlineRenderer

Struct InlineRenderer 

Source
pub struct InlineRenderer<W: Write> { /* private fields */ }
Expand description

Inline mode renderer implementing the one-writer rule.

This struct owns terminal output and enforces that all writes go through it. Cleanup is guaranteed via Drop.

Implementations§

Source§

impl<W: Write> InlineRenderer<W>

Source

pub fn new(writer: W, config: InlineConfig) -> Self

Create a new inline renderer.

§Arguments
  • writer - The terminal output (takes ownership to enforce one-writer rule).
  • config - Inline mode configuration.
Source

pub fn enter(&mut self) -> Result<()>

Initialize inline mode on the terminal.

For scroll-region strategy, this sets up DECSTBM. For overlay/hybrid strategy, this just prepares state.

Source

pub fn exit(&mut self) -> Result<()>

Exit inline mode, restoring terminal state.

Source

pub fn write_log(&mut self, text: &str) -> Result<()>

Write log output (goes to scrollback region).

In scroll-region mode: writes to current cursor position in scroll region. In overlay mode: saves cursor, writes, then restores cursor.

Returns Ok(()) even if there’s no log region (logs are silently dropped when UI takes the full terminal height).

Source

pub fn present_ui<F>(&mut self, render_fn: F) -> Result<()>

Present a UI frame.

§Invariants
  • Cursor position is saved before and restored after.
  • UI region is redrawn without affecting scrollback.
  • Synchronized output wraps the operation if enabled.

Trait Implementations§

Source§

impl<W: Write> Drop for InlineRenderer<W>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<W> Freeze for InlineRenderer<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for InlineRenderer<W>
where W: RefUnwindSafe,

§

impl<W> Send for InlineRenderer<W>
where W: Send,

§

impl<W> Sync for InlineRenderer<W>
where W: Sync,

§

impl<W> Unpin for InlineRenderer<W>
where W: Unpin,

§

impl<W> UnwindSafe for InlineRenderer<W>
where W: UnwindSafe,

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