Struct redo::HistoryBuilder

pub struct HistoryBuilder<R, C: Command<R>> { /* fields omitted */ }

Builder for a History.

Examples

let history = History::builder()
    .capacity(100)
    .limit(100)
    .saved(false)
    .default();

Methods

impl<R, C: Command<R>> HistoryBuilder<R, C>

pub fn capacity(self, capacity: usize) -> HistoryBuilder<R, C>

Sets the capacity for the history.

pub fn limit(self, limit: usize) -> HistoryBuilder<R, C>

Sets the limit for the history.

Panics

Panics if limit is 0.

pub fn saved(self, saved: bool) -> HistoryBuilder<R, C>

Sets if the receiver is initially in a saved state. By default the receiver is in a saved state.

pub fn connect<F>(     self,     f: impl Into<Option<F>> ) -> HistoryBuilder<R, C> where     F: FnMut(Signal) + Send + Sync + 'static,

Decides how the signal should be handled when the state changes. By default the history does not handle any signals.

pub fn build(     self,     receiver: impl Into<R> ) -> History<R, C>

Builds the history.

impl<R: Default, C: Command<R>> HistoryBuilder<R, C>

pub fn default(self) -> History<R, C>

Creates the history with a default receiver.

Trait Implementations

impl<R: Debug, C: Debug + Command<R>> Debug for HistoryBuilder<R, C>

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

Formats the value using the given formatter.