Struct redo::HistoryBuilder

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

Builder for a History.

Examples

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

Methods

impl<C: Command> HistoryBuilder<C>

pub fn new() -> HistoryBuilder<C>

Returns a builder for a history.

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

Sets the capacity for the history.

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

Sets the limit for the history.

Panics

Panics if limit is 0.

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

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

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

Builds the history.

pub fn build_with<F>(self, target: C::Target, slot: F) -> History<C, F>

Builds the history with the slot.

impl<C: Command> HistoryBuilder<C> where
    C::Target: Default, 

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

Creates the history with a default target.

pub fn default_with<F>(self, slot: F) -> History<C, F>

Creates the history with a default target.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<C: PartialEq + Command> PartialEq<HistoryBuilder<C>> for HistoryBuilder<C>

fn eq(&self, other: &HistoryBuilder<C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HistoryBuilder<C>) -> bool

This method tests for !=.

impl<C: Eq + Command> Eq for HistoryBuilder<C>

impl<C: Ord + Command> Ord for HistoryBuilder<C>

fn cmp(&self, other: &HistoryBuilder<C>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<C: PartialOrd + Command> PartialOrd<HistoryBuilder<C>> for HistoryBuilder<C>

fn partial_cmp(&self, other: &HistoryBuilder<C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &HistoryBuilder<C>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &HistoryBuilder<C>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &HistoryBuilder<C>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &HistoryBuilder<C>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C: Hash + Command> Hash for HistoryBuilder<C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<C: Command> StructuralPartialEq for HistoryBuilder<C>

impl<C: Command> StructuralEq for HistoryBuilder<C>

impl<C: Clone + Command> Clone for HistoryBuilder<C>

fn clone(&self) -> HistoryBuilder<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Command> Default for HistoryBuilder<C>

fn default() -> Self

Returns the "default value" for a type.

impl<C: Command> Serialize for HistoryBuilder<C> where
    C: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, C: Command> Deserialize<'de> for HistoryBuilder<C> where
    C: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.