Skip to main content

TextDeltaRenderer

Struct TextDeltaRenderer 

Source
pub struct TextDeltaRenderer;
Expand description

Default implementation of DeltaRenderer for text content.

This implementation follows the multi-line rendering pattern used by production CLIs:

  • Prefix and content on same line ending with newline + cursor up
  • Content updates in-place using clear, rewrite, and newline + cursor up
  • Sanitizes newlines to spaces (to prevent artificial line breaks)
  • Uses ANSI escape codes for in-place updates with full line clear
  • Applies consistent color formatting

§Output Pattern

§Full Mode (TTY with capable terminal)

[ccs-glm] Hello\n\x1b[1A             <- First chunk: prefix + content + newline + cursor up
\x1b[2K\r[ccs-glm] Hello World\n\x1b[1A  <- Second chunk: clear, rewrite, newline, cursor up
[ccs-glm] Hello World\n\x1b[1B\n       <- Final: move cursor down + newline

§Basic/None Mode (colors only or plain text)

[ccs-glm] Hello\n                      <- First chunk: simple line output
[ccs-glm] Hello World\n                <- Second chunk: full content (no in-place update)
                                      <- Final: just a newline

The multi-line pattern is the industry standard used by Rich, Ink, Bubble Tea and other production CLI libraries for clean streaming output.

Trait Implementations§

Source§

impl DeltaRenderer for TextDeltaRenderer

Source§

fn render_first_delta( accumulated: &str, prefix: &str, colors: Colors, terminal_mode: TerminalMode, ) -> String

Render the first delta of a content block. Read more
Source§

fn render_subsequent_delta( accumulated: &str, prefix: &str, colors: Colors, terminal_mode: TerminalMode, ) -> String

Render a subsequent delta (in-place update). Read more
Source§

fn render_completion(terminal_mode: TerminalMode) -> String

Render the completion of streaming. 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> 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> 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> 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.