Module LibraryDesc.Access

Pointer argument access specification.

type t = {
  1. kind : AccessKind.t;
    (*

    Kind of access.

    *)
  2. deep : bool;
    (*

    Depth of access

    • Shallow only accesses directly pointed values (may point to).
    • Deep additionally follows all pointers in values (reachable). Rarely needed.
    *)
  3. atomic : bool;
    (*

    Whether the access is atomic (i.e. doesn't race with other atomic accesses). atomic and deep should be mutually exclusive. Only meaningful for Read/Write AccessKinds.

    *)
}