RenderHarness

Struct RenderHarness 

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

Test harness for capturing rendered output.

Provides utilities for rendering components to a test buffer and converting the output to strings for snapshot testing.

§Example

use tui_dispatch::testing::RenderHarness;

let mut render = RenderHarness::new(80, 24);

// Render a component
let output = render.render_to_string(|frame| {
    my_component.render(frame, frame.area(), props);
});

// Use with insta for snapshot testing
insta::assert_snapshot!(output);

Implementations§

Source§

impl RenderHarness

Source

pub fn new(width: u16, height: u16) -> Self

Create a new render harness with the specified dimensions.

Source

pub fn render<F>(&mut self, render_fn: F) -> &Buffer
where F: FnOnce(&mut Frame<'_>),

Render using the provided function and return the buffer.

Source

pub fn render_to_string<F>(&mut self, render_fn: F) -> String
where F: FnOnce(&mut Frame<'_>),

Render and convert the buffer to a string representation.

The output includes ANSI escape codes for colors and styles.

Source

pub fn render_to_string_plain<F>(&mut self, render_fn: F) -> String
where F: FnOnce(&mut Frame<'_>),

Render and convert to a plain string (no ANSI codes).

Useful for simple text assertions without style information.

Source

pub fn size(&self) -> (u16, u16)

Get the current terminal size.

Source

pub fn resize(&mut self, width: u16, height: u16)

Resize the terminal.

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