History<'State, 'Delta> (FSharp.Data.Adaptive)

History<'State, 'Delta> Type

Namespace: FSharp.Data.Traceable
Assembly: FSharp.Data.Adaptive.dll
Base Type: AdaptiveObject
All Interfaces: IAdaptiveValue<'State> , IAdaptiveValue , IAdaptiveObject

History and HistoryReader are the central implementation for traceable data-types. The allow to construct a dependent History (by passing an input-reader) or imperatively performing operations on the history while keeping track of all output-versions that may exist.

Constructors

Constructor	Description
`History(input, t)` Full Usage: `History(input, t)` Parameters: input : `unit -> IOpReader<'Delta>` t : `Traceable<'State, 'Delta>` Returns: `History<'State, 'Delta>`	input : `unit -> IOpReader<'Delta>` t : `Traceable<'State, 'Delta>` Returns: `History<'State, 'Delta>`
`History(t)` Full Usage: `History(t)` Parameters: t : `Traceable<'State, 'Delta>` Returns: `History<'State, 'Delta>`	t : `Traceable<'State, 'Delta>` Returns: `History<'State, 'Delta>`
`History(input, t, finalize)` Full Usage: `History(input, t, finalize)` Parameters: input : `unit -> IOpReader<'Delta>` t : `Traceable<'State, 'Delta>` finalize : `'Delta -> unit` Returns: `History<'State, 'Delta>`	input : `unit -> IOpReader<'Delta>` t : `Traceable<'State, 'Delta>` finalize : `'Delta -> unit` Returns: `History<'State, 'Delta>`
`History(t, finalize)` Full Usage: `History(t, finalize)` Parameters: t : `Traceable<'State, 'Delta>` finalize : `'Delta -> unit` Returns: `History<'State, 'Delta>`	t : `Traceable<'State, 'Delta>` finalize : `'Delta -> unit` Returns: `History<'State, 'Delta>`

Instance members

Instance member	Description
`this.GetValue` Full Usage: `this.GetValue` Parameters: token : `AdaptiveToken` Returns: `'State`	Adaptively gets the history'State current state token : `AdaptiveToken` Returns: `'State`
`this.NewReader` Full Usage: `this.NewReader` Parameters: trace : `Traceable<'ViewState, 'ViewDelta>` mapping : `'Delta -> 'ViewDelta` Returns: `IOpReader<'ViewState, 'ViewDelta>`	Creates a new reader on the history trace : `Traceable<'ViewState, 'ViewDelta>` mapping : `'Delta -> 'ViewDelta` Returns: `IOpReader<'ViewState, 'ViewDelta>`
`this.NewReader` Full Usage: `this.NewReader` Parameters: trace : `Traceable<'ViewState, 'ViewDelta>` mapping : `'State -> 'Delta -> 'ViewDelta` Returns: `IOpReader<'ViewState, 'ViewDelta>`	Creates a new reader on the history trace : `Traceable<'ViewState, 'ViewDelta>` mapping : `'State -> 'Delta -> 'ViewDelta` Returns: `IOpReader<'ViewState, 'ViewDelta>`
`this.NewReader` Full Usage: `this.NewReader` Returns: `IOpReader<'State, 'Delta>`	Creates a new reader on the history Returns: `IOpReader<'State, 'Delta>`
`this.Perform` Full Usage: `this.Perform` Parameters: op : `'Delta` Returns: `bool`	Imperatively performs operations on the history (similar to ModRef.Value <- ...). Since the history may need to be marked a Transaction needs to be current. op : `'Delta` Returns: `bool`
`this.PerformUnsafe` Full Usage: `this.PerformUnsafe` Parameters: newState : `'State` op : `'Delta` Returns: `bool`	Imperatively performs operations on the history (similar to ModRef.Value <- ...) and assumes that newState represents the current history-state with the given operations applied. (hence the Unsafe suffix) Since the history may need to be marked a Transaction needs to be current. newState : `'State` op : `'Delta` Returns: `bool`
`this.State` Full Usage: `this.State` Returns: `'State`	The current state of the history Returns: `'State`
`this.Trace` Full Usage: `this.Trace` Returns: `Traceable<'State, 'Delta>`	The traceable instance used by the history Returns: `Traceable<'State, 'Delta>`