package b0
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=00a6868b4dfa34565d0141b335622a81a0e8d5b9e3c6dfad025dabfa3df2db2a1302b492953bbbce30c3a4406c324fcec25250a00b38f6d18a69e15605e3b07e
doc/b0.b00/B00/Store/index.html
Module B00.Store
Lazy immutable stores.
These stores provide access to immutable, lazily determined, typed key-value bindings.
The value of a key in a store is defined either:
- Explicitly when the store is created.
- Lazily on the first key access via a key determination function specified at key creation time.
Once determined the value of a key in the store never changes.
XXX. Maybe move that at the B0 level.
Stores
val create : Memo.t -> dir:B0_std.Fpath.t -> binding list -> tcreate memo ~dir bs is a store with predefined bindings bs. If a key is mentioned more than once in bs the last binding takes over. The store uses memo to determine other keys as needed. dir is a scratch directory used by key determination functions to write memoized file outputs.
val dir : t -> B0_std.Fpath.tdir s is the scratch directory of s. Key determination functions using this directory to write files should do so using nice file name prefixes (e.g. lowercased module or lib names) to avoid name clashes.
val key : ?mark:string -> (t -> Memo.t -> 'a B0_std.Fut.t) -> 'a keykey ~mark det is a new key whose value is determined on access by the future:
det s (Memo.with_mark mark (Store.memo s))mark defaults to "".
val get : t -> 'a key -> 'a B0_std.Fut.tget s k is a future that dermines with the value of k in s.