package gel

  1. Overview
  2. Docs
package gel
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module GelSource

Sourcetype 'a t = {
  1. g : 'a;
}

A shim to mark non-record fields global. "GEL" stands for "Global Even if inside a Local", but is kept short since we'll need this boilerplate a lot.

For example, if you have a list:

  type t = string list

and want to make it local, but still keep the strings global, you can write:

  type t = string Gel.t list

and it will be so, but with some extra boilerplate when using it.

This is for use with existing types that don't have the desired global_ annotation. If you find yourself reaching for this for a new type you are defining, you can avoid the boilerplate. For example:

  type t =
    { global_ foo : string
    ; bar : int
    }

  type t =
    | Foo of global_ string
    | Bar of { global_ foo : string; bar : int }
    | Baz of global_ string * int * global_ string
include Bin_prot.Binable.S1 with type 'a t := 'a t
Sourceval bin_size_t : ('a, 'a t) Bin_prot.Size.sizer1
Sourceval bin_write_t : ('a, 'a t) Bin_prot.Write.writer1
Sourceval bin_read_t : ('a, 'a t) Bin_prot.Read.reader1
Sourceval __bin_read_t__ : ('a, int -> 'a t) Bin_prot.Read.reader1
Sourceval bin_writer_t : ('a, 'a t) Bin_prot.Type_class.S1.writer
Sourceval bin_reader_t : ('a, 'a t) Bin_prot.Type_class.S1.reader
Sourceval bin_t : ('a, 'a t) Bin_prot.Type_class.S1.t
include Ppx_compare_lib.Comparable.S1 with type 'a t := 'a t
Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
include Ppx_compare_lib.Equal.S1 with type 'a t := 'a t
Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
include Ppx_hash_lib.Hashable.S1 with type 'a t := 'a t
Sourceval hash_fold_t : (Base.Hash.state -> 'a -> Base.Hash.state) -> Base.Hash.state -> 'a t -> Base.Hash.state
include Sexplib0.Sexpable.S1 with type 'a t := 'a t
Sourceval t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t
Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
Sourceval create : 'a -> 'a t
Sourceval g : 'a t -> 'a
Sourceval map : 'a t -> f:('a -> 'b) -> 'b t
Sourceval globalize : _ -> 'a t -> 'a t
Sourceval drop_some : 'a t Base.option -> 'a Base.option

Removes a Gel.t from inside an option type with zero runtime cost. This is useful when some other function returns an X.t Gel.t option, you know X.t is mode-crossing, and you want to drop the inner Gel.t without allocating another local option.

Sourceval drop_ok : ('a t, 'b) Base.Result.t -> ('a, 'b) Base.Result.t

Like drop_some, but for the Ok _ branch of a result.

Sourceval drop_error : ('a, 'b t) Base.Result.t -> ('a, 'b) Base.Result.t

Like drop_some, but for the Error _ branch of a result.

Sourceval inject_some : 'a Base.option -> 'a t Base.option

Treat an existing global option as a local while maintaining the knowledge that the data inside the option is global. Zero runtime cost.

"Injects some gel between the option and its Some _ case."

Sourceval inject_ok : ('a, 'b) Base.Result.t -> ('a t, 'b) Base.Result.t

Like inject_some, but for the Ok _ case of a result.

Sourceval inject_error : ('a, 'b) Base.Result.t -> ('a, 'b t) Base.Result.t

Like inject_some, but for the Error _ case of a result.

Sourceval inject_result : ('a, 'b) Base.Result.t -> ('a t, 'b t) Base.Result.t

Like inject_some, but for the contents of a result.