Struct MatrixRain 

pub struct MatrixRain<'a> { /* private fields */ }

The ratatui widget rendering the Matrix digital rain effect.

MatrixRain borrows the MatrixConfig for the lifetime of the render call and consumes itself when rendered (per the StatefulWidget contract). It is intentionally stateful-only — there is no plain Widget implementation. Animation requires per-frame state (column streams, RNG, timing, cached color tier) that a stateless wrapper would either reset every frame or hide behind surprising global mutable state.

Example

use matrix_rain::{MatrixConfig, MatrixRain, MatrixRainState};
use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::widgets::StatefulWidget;

let cfg = MatrixConfig::default();
let mut state = MatrixRainState::with_seed(0xC0FFEE);
let area = Rect::new(0, 0, 40, 12);
let mut buf = Buffer::empty(area);

// The widget is constructed once per frame and consumed by render().
MatrixRain::new(&cfg).render(area, &mut buf, &mut state);

Inside a ratatui Terminal::draw closure:

terminal.draw(|f| {
    f.render_stateful_widget(MatrixRain::new(&cfg), f.size(), &mut state);
})?;

Implementations

impl<'a> MatrixRain<'a>

pub fn new(config: &'a MatrixConfig) -> Self

Create a new MatrixRain widget bound to the given configuration. The config is borrowed for the lifetime of the widget; build it once outside the render loop and pass &cfg here each frame.

Trait Implementations

impl<'a> StatefulWidget for MatrixRain<'a>

type State = MatrixRainState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.