Module `Mode.Value`

The most general mode. Used in most type checking, including in value bindings in Env

module Monadic : sig ... end

module Comonadic : sig ... end

module Axis : sig ... end

type ('a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i, 'j) modes = {

areality : 'a;
linearity : 'b;
uniqueness : 'c;
portability : 'd;
contention : 'e;
forkable : 'f;
yielding : 'g;
statefulness : 'h;
visibility : 'i;
staticity : 'j;

}

module Const : sig ... end

type error =

| Monadic of Ocaml_typing.Mode.Value.Monadic.error
| Comonadic of Ocaml_typing.Mode.Value.Comonadic.error

type 'a simple_axerror := 'a Ocaml_typing.Mode.simple_error

type simple_error =

| Error : 'a Ocaml_typing.Mode.Value.Axis.t * 'a Ocaml_typing.Mode.Value.simple_axerror -> Ocaml_typing.Mode.Value.simple_error

type 'd t =
  ('d Ocaml_typing.Mode.Value.Monadic.t,
    'd Ocaml_typing.Mode.Value.Comonadic.t)
    Ocaml_typing.Mode.monadic_comonadic

include Ocaml_typing.Mode_intf.Common
  with module Const := Ocaml_typing.Mode.Value.Const
   and type error := Ocaml_typing.Mode.Value.error
   and type simple_error := Ocaml_typing.Mode.Value.simple_error
   and type 'd t := 'd Ocaml_typing.Mode.Value.t

val print_error : 
  Ocaml_typing.Mode_hint.pinpoint ->
  Ocaml_typing.Mode.Value.error ->
  Ocaml_typing.Mode_intf.print_error

Takes a submode error accompanied by a pinpoint of the original submode, returns an explaining printer for each side. Each printer prints either a mode constant name, or "mode because ...". The function assumes pinpoint is already printed, which allows simplifying its own printing. The caller is responsible for printing pinpoint and placing the result of this function in a suitable linguistic context.

type equate_error =
  Ocaml_typing.Mode_intf.equate_step * Ocaml_typing.Mode.Value.error

val to_simple_error : 
  Ocaml_typing.Mode.Value.error ->
  Ocaml_typing.Mode.Value.simple_error

type l =
  (Ocaml_typing.Allowance.allowed * Ocaml_typing.Allowance.disallowed)
    Ocaml_typing.Mode.Value.t

Left-only mode

type r =
  (Ocaml_typing.Allowance.disallowed * Ocaml_typing.Allowance.allowed)
    Ocaml_typing.Mode.Value.t

Right-only mode

type lr =
  (Ocaml_typing.Allowance.allowed * Ocaml_typing.Allowance.allowed)
    Ocaml_typing.Mode.Value.t

Left-right mode

include Ocaml_typing.Allowance.Allow_disallow
  with type (_, _, 'd) sided = 'd Ocaml_typing.Mode.Value.t

type (_, _, 'd) sided = 'd Ocaml_typing.Mode.Value.t

val disallow_right : 
  ('a, 'b, 'l * 'r) Ocaml_typing.Mode.Value.sided ->
  ('a, 'b, 'l * Ocaml_typing.Allowance.disallowed)
    Ocaml_typing.Mode.Value.sided

Disallows on the right.

val disallow_left : 
  ('a, 'b, 'l * 'r) Ocaml_typing.Mode.Value.sided ->
  ('a, 'b, Ocaml_typing.Allowance.disallowed * 'r)
    Ocaml_typing.Mode.Value.sided

Disallows a the left.

val allow_right : 
  ('a, 'b, 'l * Ocaml_typing.Allowance.allowed) Ocaml_typing.Mode.Value.sided ->
  ('a, 'b, 'l * 'r) Ocaml_typing.Mode.Value.sided

Generalizes a right-hand-side allowed to be any allowance.

val allow_left : 
  ('a, 'b, Ocaml_typing.Allowance.allowed * 'r) Ocaml_typing.Mode.Value.sided ->
  ('a, 'b, 'l * 'r) Ocaml_typing.Mode.Value.sided

Generalizes a left-hand-side allowed to be any allowance.

val min : Ocaml_typing.Mode.Value.lr

val max : Ocaml_typing.Mode.Value.lr

val legacy : Ocaml_typing.Mode.Value.lr

val newvar : unit -> ('l * 'r) Ocaml_typing.Mode.Value.t

val submode : 
  ?pp:Ocaml_typing.Mode_hint.pinpoint ->
  (Ocaml_typing.Allowance.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * Ocaml_typing.Allowance.allowed) Ocaml_typing.Mode.Value.t ->
  (unit, Ocaml_typing.Mode.Value.error) Stdlib.result

Takes the actual and expected mode of something, check that the actual mode is less than the expected mode. In case of error, the error is returned and no mutation is done.

The two modes should be hinted sufficently that the submode is self-evident. In particular, the two modes should be about the "same thing". See the notes How to submode for details.

val submode_err : 
  Ocaml_typing.Mode_hint.pinpoint ->
  (Ocaml_typing.Allowance.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * Ocaml_typing.Allowance.allowed) Ocaml_typing.Mode.Value.t ->
  unit

Similar to submode, but instead of returning an error, raise user-friendly errors directly, with pinpoint describing the thing whose actual and expected modes are being checked.

If you need more than pinpoint as the context in the error message, consider submode.

val equate : 
  Ocaml_typing.Mode.Value.lr ->
  Ocaml_typing.Mode.Value.lr ->
  (unit, Ocaml_typing.Mode.Value.equate_error) Stdlib.result

val submode_exn : 
  ?pp:Ocaml_typing.Mode_hint.pinpoint ->
  (Ocaml_typing.Allowance.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * Ocaml_typing.Allowance.allowed) Ocaml_typing.Mode.Value.t ->
  unit

Similiar to submode, but crashes the compiler if errors. Use this function if the submode is guaranteed to succeed.

val equate_exn : 
  Ocaml_typing.Mode.Value.lr ->
  Ocaml_typing.Mode.Value.lr ->
  unit

val join : 
  (Ocaml_typing.Allowance.allowed * 'r) Ocaml_typing.Mode.Value.t list ->
  Ocaml_typing.Allowance.left_only Ocaml_typing.Mode.Value.t

val meet : 
  ('l * Ocaml_typing.Allowance.allowed) Ocaml_typing.Mode.Value.t list ->
  Ocaml_typing.Allowance.right_only Ocaml_typing.Mode.Value.t

val newvar_above : 
  (Ocaml_typing.Allowance.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * 'r_) Ocaml_typing.Mode.Value.t * bool

val newvar_below : 
  ('l * Ocaml_typing.Allowance.allowed) Ocaml_typing.Mode.Value.t ->
  ('l_ * 'r) Ocaml_typing.Mode.Value.t * bool

val print : 
  ?verbose:bool ->
  unit ->
  Stdlib.Format.formatter ->
  ('l * 'r) Ocaml_typing.Mode.Value.t ->
  unit

val zap_to_ceil : 
  ('l * Ocaml_typing.Allowance.allowed) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Mode.Value.Const.t

val zap_to_floor : 
  (Ocaml_typing.Allowance.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Mode.Value.Const.t

val of_const : 
  ?hint_monadic:('l * 'r) Ocaml_typing.Allowance.neg Hint.const ->
  ?hint_comonadic:('l * 'r) Ocaml_typing.Allowance.pos Hint.const ->
  Ocaml_typing.Mode.Value.Const.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t

val to_const_exn : 
  Ocaml_typing.Mode.Value.lr ->
  Ocaml_typing.Mode.Value.Const.t

module List : sig ... end

val proj_comonadic : 
  'a Ocaml_typing.Mode.Value.Comonadic.Axis.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t ->
  ('a, 'l * 'r) Ocaml_typing.Mode.mode

val proj_monadic : 
  'a Ocaml_typing.Mode.Value.Monadic.Axis.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t ->
  ('a, 'r * 'l) Ocaml_typing.Mode.mode

val meet_const : 
  Ocaml_typing.Mode.Value.Comonadic.Const.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t

val join_const : 
  Ocaml_typing.Mode.Value.Monadic.Const.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t

val max_with_comonadic : 
  'a Ocaml_typing.Mode.Value.Comonadic.Axis.t ->
  ('a, 'l * 'r) Ocaml_typing.Mode.mode ->
  (Ocaml_typing.Mode.disallowed * 'r) Ocaml_typing.Mode.Value.t

max_with ax elt returns max but with the axis ax set to elt.

val min_with_comonadic : 
  'a Ocaml_typing.Mode.Value.Comonadic.Axis.t ->
  ('a, 'l * 'r) Ocaml_typing.Mode.mode ->
  ('l * Ocaml_typing.Mode.disallowed) Ocaml_typing.Mode.Value.t

min_with ax elt returns min but with the axis ax set to elt.

val min_with_monadic : 
  'a Ocaml_typing.Mode.Value.Monadic.Axis.t ->
  ('a, 'l * 'r) Ocaml_typing.Mode.mode ->
  ('r * Ocaml_typing.Mode.disallowed) Ocaml_typing.Mode.Value.t

val meet_with : 
  'a Ocaml_typing.Mode.Value.Comonadic.Axis.t ->
  'a ->
  ('l * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t

val join_with : 
  'a Ocaml_typing.Mode.Value.Monadic.Axis.t ->
  'a ->
  ('l * 'r) Ocaml_typing.Mode.Value.t ->
  ('l * 'r) Ocaml_typing.Mode.Value.t

val zap_to_legacy : 
  Ocaml_typing.Mode.Value.lr ->
  Ocaml_typing.Mode.Value.Const.t

val comonadic_to_monadic_min : 
  ?hint:
    ('r * Ocaml_typing.Mode.disallowed) Ocaml_typing.Allowance.neg Hint.morph ->
  ('l * 'r) Ocaml_typing.Mode.Value.Comonadic.t ->
  ('r * Ocaml_typing.Mode.disallowed) Ocaml_typing.Mode.Value.Monadic.t

val monadic_to_comonadic_max : 
  ('r * Ocaml_typing.Mode.disallowed) Ocaml_typing.Mode.Value.Monadic.t ->
  (Ocaml_typing.Mode.disallowed * 'r) Ocaml_typing.Mode.Value.Comonadic.t

val close_over : 
  (('l * Ocaml_typing.Mode.allowed) Ocaml_typing.Mode.Value.Monadic.t,
    (Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.Comonadic.t)
    Ocaml_typing.Mode.monadic_comonadic ->
  Ocaml_typing.Mode.Value.l

Returns the lower bound needed for B -> C in relation to A

val partial_apply : 
  (Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Mode.Value.l

Returns the lower bound needed for B -> C in relation to A -> B -> C

Module Mode.Value

Module `Mode.Value`