Module ReactiveData.RListSource

include module type of ReactiveData.RList with type 'a t = 'a ReactiveData.RList.t and type 'a handle = 'a ReactiveData.RList.handle
Sourcetype 'a p =
  1. | I of int * 'a
    (*

    I (i, v) adds v at position i

    *)
  2. | R of int
    (*

    R i removes i-th element

    *)
  3. | U of int * 'a
    (*

    U (i, v) substitutes i-th element with v

    *)
  4. | X of int * int
    (*

    X (i, j) swaps the i-th and j-th elements

    *)

Patch operation on lists. All operations are of linear complexity.

Sourcetype 'a patch = 'a p list

A patch is a list of patch operations. The operations are applied in the order they appear in the list.

The indices correspond to list contents after the operations that appear earlier in the list have been applied, not to the contents before the whole patch operation.

A patch comprised of I, R, and U steps with increasing indices can be applied in time O(m + n), where m is the patch length and n is the current size of the list. (Arbitrary patches are slower, requiring O(m * n).)

include ReactiveData.S with type 'a data = 'a list and type 'a patch := 'a patch with type 'a t = 'a ReactiveData.RList.t with type 'a handle = 'a ReactiveData.RList.handle

Reactive version of the data container

Sourcetype 'a data = 'a list

Raw (non-reactive) version of the data container

Sourcetype 'a msg =
  1. | Patch of 'a patch
    (*

    Patch p triggers the application of p on the current contents

    *)
  2. | Set of 'a data
    (*

    With Set d, d becomes the new content

    *)

Message format

Handle that permits applying incremental updates

Sourceval empty : 'a t

Empty data structure

Sourceval from_event : 'a data -> 'a msg React.E.t -> 'a t

from_event d e is a container whose initial value is d, and which gets updated for every occurrence of e

Sourceval const : 'a data -> 'a t

Produce a constant container

Sourceval patch : 'a handle -> 'a patch -> unit

patch h p applies p on the container corresponding to h

Sourceval set : 'a handle -> 'a data -> unit

set h d sets the contents of the container corresponding to h, disregarding previous contents

Sourceval map_msg : ('a -> 'b) -> 'a msg -> 'b msg

Transform a message

Sourceval fold : ('a -> 'b msg -> 'a) -> 'b t -> 'a -> 'a React.signal

fold f c v accumulates the updates on c with f starting from v.

The result is a signal of value f m_n (f ... (f m_1 v)), where m_1 ... m_n are the messages that have been applied since the beginning of fold. m_1 is a pseudo-message Set l, accounting for the contents l of c at the time when accumulation starts.

Sourceval event : 'a t -> 'a msg React.E.t

Event whose occurrences correspond to container updates

Sourceval cons : 'a -> 'a handle -> unit

Add element to the beginning

Sourceval snoc : 'a -> 'a handle -> unit

Add element to the end

Sourceval insert : 'a -> int -> 'a handle -> unit

insert v i h adds v as the i-th position in the container corresponding to h. The indices of the subsequent elements change.

Sourceval remove : int -> 'a handle -> unit

remove i h removes the i-th position from the container corresponding to h. The indices of the subsequent elements change.

Sourceval remove_last : ('a t * 'a handle) -> unit

remove_last a removes the last element of a

Sourceval remove_eq : ?eq:('a -> 'a -> bool) -> ('a t * 'a handle) -> 'a -> unit

remove_eq l x removes the first occurence of x from l

Sourceval update : 'a -> int -> 'a handle -> unit

update v i h substitutes the i-th element of the container corresponding to h with v

Sourceval update_eq : ?eq:('a -> 'a -> bool) -> ('a t * 'a handle) -> 'a -> 'a -> unit

update_eq l a b substitutes the first occurence of a (according to eq) in l with b

Sourceval move : int -> int -> 'a handle -> unit

move i offset h moves the i-th element of the container corresponding by offset positions in h, modifying the indices of other elements

Sourceval singleton : 'a -> 'a t

Produce container list containing a single, constant element

Sourceval rev : 'a t -> 'a t

rev a is the reversal of a; rev a gets updated along with a

Sourceval filter : ('a -> bool) -> 'a t -> 'a t

filter pred l keeps the elements of l matching pred; gets updated when l is. pred should be a pure function

Sourceval for_all : ('a -> bool) -> 'a t -> bool React.S.t

for_all fn l is a bool React.S.t verifying that all elements x of l satisfy fn x

include Eliom_shared_sigs.RLIST with type 'a t := 'a t and type 'a sv := 'a Value.t and type 'a handle := 'a handle and type 'a signal := 'a React.S.t and type 'a ct := 'a ReactiveData.RList.t and type 'a chandle := 'a ReactiveData.RList.handle
Sourceval create : ?default: ('a ReactiveData.RList.t * 'a ReactiveData.RList.handle) option Eliom_client_value.t -> ?reset_default:bool -> 'a list -> 'a t * 'a handle

create ?default ?reset_default l produces a pair l, f, where s is a (shared) reactive list, and f is a handle for manipulating the list.

The initial value of the list is l, unless default is provided. default, if provided, is used as the client-side list (and corresponding handle). reset_default, if set to true (default: false), resets the value of default to l.

Sourceval concat : 'a t -> 'a t -> 'a t
Sourceval value : 'a t -> 'a list Value.t
Sourceval signal : ?eq:('a -> 'a -> bool) Value.t -> 'a t -> 'a list React.S.t
Sourceval singleton_s : 'a React.S.t -> 'a t
Sourceval map : ('a -> 'b) Value.t -> 'a t -> 'b t
Sourceval from_signal : ?eq:('a -> 'a -> bool) Value.t -> 'a list React.S.t -> 'a t
Sourceval acc_e : ?init:('a t * 'a handle) -> 'a React.E.t Eliom_client_value.t -> 'a t
Sourcemodule Lwt : sig ... end

Cooperative versions of the ReactiveData operators