Struct MatrixConfigBuilder 

pub struct MatrixConfigBuilder { /* private fields */ }

Fluent builder for MatrixConfig.

Construct via MatrixConfig::builder or MatrixConfigBuilder::new. Setters take and return self so they can be chained. Call build to validate and produce a MatrixConfig, or receive a MatrixError describing which invariant failed.

Example

use matrix_rain::{CharSet, MatrixConfig, Theme};

let cfg = MatrixConfig::builder()
    .fps(60)
    .density(0.8)
    .charset(CharSet::Hex)
    .theme(Theme::Cyan)
    .build()
    .unwrap();

Implementations

impl MatrixConfigBuilder

pub fn new() -> Self

Returns a new builder seeded with MatrixConfig::default.

pub fn charset(self, charset: CharSet) -> Self

Set the glyph source. See CharSet.

pub fn theme(self, theme: Theme) -> Self

Set the color theme. See Theme.

pub fn fps(self, fps: u16) -> Self

Set frames per second. Must be >= 1; build rejects 0.

pub fn speed(self, speed: f32) -> Self

Set the global speed multiplier. Must be finite and > 0.0.

pub fn density(self, density: f32) -> Self

Set the column-activity density. Must be finite and in [0.0, 1.0].

pub fn min_trail(self, min_trail: u16) -> Self

Set the minimum trail length. Must be >= 1 and <= max_trail.

pub fn max_trail(self, max_trail: u16) -> Self

Set the maximum trail length. Must be <= MAX_TRAIL_LIMIT.

pub fn mutation_rate(self, mutation_rate: f32) -> Self

Set the per-cell glyph reroll probability per tick. Finite, [0.0, 1.0].

pub fn bold_head(self, bold_head: bool) -> Self

Apply Modifier::BOLD to the head cell when true.

pub fn head_white(self, head_white: bool) -> Self

Use ColorRamp.head for the head cell when true, ColorRamp.bright when false.

pub fn glitch(self, glitch: f32) -> Self

Set the per-cell glitch (color flicker) probability per tick. Finite, [0.0, 1.0]. See MatrixConfig::glitch.

pub fn background(self, background: Option<Color>) -> Self

Set the background color. None for transparent (skip cells in the fade zone); Some(c) for a known compositing background.

pub fn build(self) -> Result<MatrixConfig, MatrixError>

Validate the configured fields and return a MatrixConfig.

Errors

Returns MatrixError::InvalidConfig if any of the following fails (checked in order):

• fps >= 1
• speed is finite and > 0
• density is finite and in [0.0, 1.0]
• min_trail >= 1
• min_trail <= max_trail
• max_trail <= MAX_TRAIL_LIMIT
• mutation_rate is finite and in [0.0, 1.0]
• glitch is finite and in [0.0, 1.0]

Returns MatrixError::EmptyCharset when CharSet::Custom resolves to an empty Vec, and MatrixError::InvalidConfig when any character in a charset is a char::is_control.

Boundary values are accepted: density == 0.0 / 1.0, min_trail == max_trail, mutation_rate == 0.0 / 1.0, glitch == 0.0 / 1.0.

Trait Implementations

impl Clone for MatrixConfigBuilder

fn clone(&self) -> MatrixConfigBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MatrixConfigBuilder

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

Formats the value using the given formatter.

impl Default for MatrixConfigBuilder

fn default() -> Self

Returns the “default value” for a type.