package async_kernel

  1. Overview
  2. Docs
package async_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
type nonrec 'a t = 'a -> unit Deferred.t
module type S = sig ... end
module type S1 = sig ... end
module type S2 = sig ... end
module type S3 = sig ... end
val invariant : Core_kernel.Source_code_position.t -> 'a -> ('a -> Core_kernel.Sexp.t) -> (unit -> unit Deferred.t) -> unit Deferred.t
val check_field : 'a -> 'b t -> unit Deferred.t -> ('a, 'b) Core_kernel.Field.t -> unit Deferred.t

check_field can be used to check record fields when using [@@deriving fields]. Idiomatic usage looks like:

type t = { foo : Foo.t ; bar : Bar.t }
[@@deriving fields]

let invariant t =
  Invariant.Async.invariant [%here] t [%sexp_of: t] (fun () ->
    let check inv = Invariant.Async.check_field t inv in
    Fields.fold ~init:(return ())
      ~foo: (check Foo.invariant)
      ~bar: (check Bar.invariant)

When some fields have synchronous invariants, or do not need to be checked, it may be useful to define a second wrapper around check_field:

type t = { foo : Foo.t ; bar : Bar.t ; quux : Quux.t }
[@@deriving fields]

let invariant t =
  Invariant.Async.invariant [%here] t [%sexp_of: t] (fun () ->
    let check' inv = Invariant.Async.check_field t inv in
    let check inv = check' (fun x -> inv x; return ()) in
    Fields.fold ~init:(return ())
      ~foo:  (check' Foo.invariant)
      ~bar:  (check  Bar.invariant)
      ~quux: (check  ignore)
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct