Struct undo::HistoryBuilder

pub struct HistoryBuilder<T> { /* fields omitted */ }

Builder for a History.

Examples

History::builder()
    .capacity(100)
    .limit(100)
    .saved(false)
    .default()

Methods

impl<T> HistoryBuilder<T>

pub fn new() -> HistoryBuilder<T>

Returns a builder for a history.

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

Sets the specified capacity for the history.

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

Sets the limit for the history.

Panics

Panics if limit is 0.

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

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

pub fn connect(self, slot: impl FnMut(Signal) + 'static) -> HistoryBuilder<T>

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

pub fn build(self, target: T) -> History<T>

Builds the history.

impl<T: Default> HistoryBuilder<T>

pub fn default(self) -> History<T>

Creates the history with a default target.

Trait Implementations

impl<T> Default for HistoryBuilder<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Debug> Debug for HistoryBuilder<T>

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

Formats the value using the given formatter.