Module `Data.Local`Source

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

val wrap : 
  access:'k Capsule_expert.Access.t ->
  'a @ local ->
  ('a, 'k) Capsule_expert.Data.t @ local @@ portable

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

Source

val unwrap : 
  access:'k Capsule_expert.Access.t ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  'a @ local @@ portable

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

Source

val wrap_unique : 
  access:'k Capsule_expert.Access.t ->
  'a @ local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local portable @@ portable

Like wrap, but for unique values.

Source

val unwrap_unique : 
  access:'k Capsule_expert.Access.t ->
  ('a, 'k) Capsule_expert.Data.t @ local portable ->
  'a @ local portable @@ portable

Like unwrap, but for unique values.

Source

val wrap_once : 
  access:'k Capsule_expert.Access.t ->
  'a @ local local ->
  ('a, 'k) Capsule_expert.Data.t @ local local @@ portable

Like wrap, but for once values.

Source

val unwrap_once : 
  access:'k Capsule_expert.Access.t ->
  ('a, 'k) Capsule_expert.Data.t @ local local ->
  'a @ local local @@ portable

Like unwrap, but for once values.

Source

val unwrap_shared : 
  'a 'k. access:'k Capsule_expert.Access.t @ local ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  'a @ local local @@ portable

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.

Source

val create : 
  (unit -> 'a @ local) @ local local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local @@ portable

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

Source

val map : 
  password:'k Capsule_expert.Password.t @ local ->
  f:('a @ local -> 'b @ local) @ local local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  ('b, 'k) Capsule_expert.Data.t @ local @@ portable

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

Source

val both : 
  ('a, 'k) Capsule_expert.Data.t @ local ->
  ('b, 'k) Capsule_expert.Data.t @ local ->
  ('a * 'b, 'k) Capsule_expert.Data.t @ local @@ portable

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

Source

val fst : 
  ('a * 'b, 'k) Capsule_expert.Data.t @ local ->
  ('a, 'k) Capsule_expert.Data.t @ local @@ portable

fst t gives a pointer to the first value inside t

Source

val snd : 
  ('a * 'b, 'k) Capsule_expert.Data.t @ local ->
  ('b, 'k) Capsule_expert.Data.t @ local @@ portable

snd t gives a pointer to the second value inside t

Source

val extract : 
  password:'k Capsule_expert.Password.t @ local ->
  f:
    ('a @ local -> 'b @ local portable local portable contended) @ local local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  'b @ local portable local portable contended @@ portable

extract ~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.

Source

val inject : 
  'a 'k. 'a @ local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local @@ portable

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.

Source

val project : 
  'a 'k. ('a, 'k) Capsule_expert.Data.t @ local ->
  'a @ local contended @@ portable

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.

Source

val project_shared : 
  'a 'k. key:'k Capsule_expert.Key.t @ local ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  'a @ local local @@ portable

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.

Source

val bind : 
  password:'k Capsule_expert.Password.t @ local ->
  f:
    ('a @ local -> ('b, 'j) Capsule_expert.Data.t @ local) @ local local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  ('b, 'j) Capsule_expert.Data.t @ local @@ portable

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

Source

val iter : 
  password:'k Capsule_expert.Password.t @ local ->
  f:('a @ local -> unit) @ local local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  unit @@ portable

iter is extract with result type specialized to unit.

Source

val map_shared : 
  'a 'b 'k. password:'k Capsule_expert.Password.Shared.t @ local ->
  f:('a @ local local -> 'b @ local) @ local local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  ('b, 'k) Capsule_expert.Data.t @ local @@ portable

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.

Source

val extract_shared : 
  'a 'b 'k. password:'k Capsule_expert.Password.Shared.t @ local ->
  f:
    ('a @ local local -> 'b @ local portable local portable contended) @ local local portable ->
  ('a, 'k) Capsule_expert.Data.t @ local ->
  'b @ local portable local portable contended @@ portable

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.

Module Data.LocalSource

Module `Data.Local`Source