Module Capsule_expert.DataSource
Pointers to data within a capsule.
('a, 'k) t is the type of 'as within the capsule 'k. It can be passed between threads. Operations on ('a, 'k) t require a 'k Password.t associated with the capsule 'k.
val wrap :
access:'k Capsule_expert.Access.t ->
'a ->
('a, 'k) Capsule_expert.Data.t @@ portablewrap ~access v returns a pointer to the value v, which lives in the capsule 'k. 'k is always the current capsule.
val unwrap :
access:'k Capsule_expert.Access.t ->
('a, 'k) Capsule_expert.Data.t ->
'a @@ portableunwrap ~access t returns the value of t, which lives in the capsule 'k. 'k is always the current capsule.
val wrap_unique :
access:'k Capsule_expert.Access.t ->
'a @ portable ->
('a, 'k) Capsule_expert.Data.t @ portable @@ portableLike wrap, but for unique values.
val unwrap_unique :
access:'k Capsule_expert.Access.t ->
('a, 'k) Capsule_expert.Data.t @ portable ->
'a @ portable @@ portableLike unwrap, but for unique values.
val wrap_once :
access:'k Capsule_expert.Access.t ->
'a @ local ->
('a, 'k) Capsule_expert.Data.t @ local @@ portableLike wrap, but for once values.
val unwrap_once :
access:'k Capsule_expert.Access.t ->
('a, 'k) Capsule_expert.Data.t @ local ->
'a @ local @@ portableLike unwrap, but for once values.
val wrap_once_unique :
access:'k Capsule_expert.Access.t ->
'a @ portable local ->
('a, 'k) Capsule_expert.Data.t @ portable local @@ portableLike wrap, but for once unique values.
val unwrap_once_unique :
access:'k Capsule_expert.Access.t ->
('a, 'k) Capsule_expert.Data.t @ portable local ->
'a @ portable local @@ portableLike unwrap, but for once unique values.
unwrap_shared ~access t returns the shared value of t, which lives in the capsule 'k. 'k is always the current capsule. Since 'a may have been shared with other threads, 'a must cross portability.
val create :
(unit -> 'a) @ local local portable ->
('a, 'k) Capsule_expert.Data.t @@ portablecreate f runs f within the capsule 'k and returns a pointer to the result of f.
val create_once :
(unit -> 'a @ local) @ local local portable ->
('a, 'k) Capsule_expert.Data.t @ local @@ portableLike create, but for once values.
val create_unique :
(unit -> 'a @ portable) @ local local portable ->
('a, 'k) Capsule_expert.Data.t @ portable @@ portablecreate_unique f runs f within the capsule 'k and returns a pointer to the result of f.
val map :
password:'k Capsule_expert.Password.t @ local ->
f:('a -> 'b) @ local local portable ->
('a, 'k) Capsule_expert.Data.t ->
('b, 'k) Capsule_expert.Data.t @@ portablemap ~password ~f t applies f to the value of p within the capsule 'k and returns a pointer to the result.
val both :
('a, 'k) Capsule_expert.Data.t ->
('b, 'k) Capsule_expert.Data.t ->
('a * 'b, 'k) Capsule_expert.Data.t @@ portableboth 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
val extract :
password:'k Capsule_expert.Password.t @ local ->
f:('a -> 'b @ portable local portable contended) @ local local portable ->
('a, 'k) Capsule_expert.Data.t ->
'b @ portable local portable contended @@ portableextract ~password ~f t applies f to the value of t within the capsule 'k and returns the result. The result is within 'k so must be portable and is marked contended.
inject v creates a pointer to a 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 is marked contended. The value is required to always be portable, so unlike extract, project does not require permission to access 'k. This is safe because all accesses to the value happen only after it's marked contended.
project_shared ~key t is like project t, but since t is a capsule associated with a key @ aliased global, the contents can be returned at shared.
val bind :
password:'k Capsule_expert.Password.t @ local ->
f:('a -> ('b, 'j) Capsule_expert.Data.t) @ local local portable ->
('a, 'k) Capsule_expert.Data.t ->
('b, 'j) Capsule_expert.Data.t @@ portablebind ~password ~f t is project (map ~password ~f t).
val iter :
password:'k Capsule_expert.Password.t @ local ->
f:('a -> unit) @ local local portable ->
('a, 'k) Capsule_expert.Data.t ->
unit @@ portableiter is extract with result type specialized to unit.
map_shared ~password ~f t applies f to the shared parts of t within the capsule 'k and returns a pointer to the result. Since 'a may have been shared with other threads, 'a must cross portability.
extract_shared ~password ~f t applies f to the shared parts of t within the capsule 'k and returns the result. The result is within 'k so must be portable and is marked contended. Since 'a may have been shared with other threads, 'a must cross portability.