Struct BasicModel

pub struct BasicModel<T, R>
where
    R: FnMut(&mut T) -> String,
{
    pub value: T,
    /* private fields */
}

A model that stores any user-provided type, and renders by calling a function provided in the constructor.

For many simple cases this avoids any need to explicitly declare a model class: instead the View::new call can, in-line, construct a BasicView giving an initial value and a render function.

Example

let view = nutmeg::View::new(
    nutmeg::models::BasicModel::new((0, 10), |(a, b)| format!("{}/{} complete", a, b)),
    nutmeg::Options::default(),
);
for _i in 0..10 {
    // Note that the callback should update `model.value`, which is the user-defined
    // type.
    view.update(|model| model.value.0 += 1);
    // ...
}

Fields

value: T

The current inner value of the model.

The type T and initial value are set by the first parameter to BasicModel::new.

The functions passed to View::update take a model as a parameter and should typically act on model.value.

Implementations

impl<T, R> BasicModel<T, R>

where R: FnMut(&mut T) -> String,

pub fn new(value: T, render_fn: R) -> BasicModel<T, R>

Construct a new BasicModel.

value is the initial inner value of the model. It may be any type but might typically be an integer, a string, or a tuple of simple values.

render_fn takes an &mut T and renders it to a string to be drawn in the progress bar.

Trait Implementations

impl<T, R> Model for BasicModel<T, R>

where R: FnMut(&mut T) -> String,

fn render(&mut self, _width: usize) -> String

Render this model into a string to draw on the console.

fn final_message(&mut self) -> String

Optionally render a final message when the view is finished.