Module Data.SharedSource

('a, 'k) t is the type of 'as in a "sub-capsule" of 'k that has a shared view of 'k and uncontended access to the sub-capsule enclosing 'a.

Both read and write operations only require 'k Access.t @ shared. However, unlike ('a, 'k) Data.t, ('a, 'k) Data.Shared.t does not cross contention.

wrap ~access v returns a pointer to the value v, which lives in the sub-capsule of 'k. 'k is always the current capsule.

unwrap ~access t returns the value of t, which lives in the sub-capsule of 'k. 'k is always the current capsule.

A 'k Key.t @ global aliased indicates that all capsules have permanent read-only access to 'k. Therefore, ('a, 'k) t can be safely exposed.

create f runs f within the sub-capsule of 'k and returns a pointer to the result.

map ~password ~f t applies f to the value of p within the sub-capsule of 'k and returns a pointer to the result.

both t1 t2 is a pointer to a pair of the values of t1 and t2.

fst t gives a pointer to the first value inside t

snd t gives a pointer to the second value inside t

extract ~password ~f t applies f to the value of t within the sub-capsule of 'k and returns the result. The result has access to 'k so must be portable and is marked contended.

inject v is a pointer to an value v injected into the capsule 'k. It's a specialization of create to values that are always uncontended.

project t returns the value of t. The result is within 'k, so must be portable and is marked contended. Since it's always portable, unlike with extract, we don't need exclusive access to 'k: all accesses to the value happen only after it's marked contended.

bind ~password ~f t is project (map ~password ~f t).

iter is extract with result type specialized to unit.

map_into is like Capsule.map_shared but returns a Shared.t.

Functions to work with ('a, 'k) t @ local.