package base

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

Full standard library replacement for OCaml

Install

dune-project

Dependency

github.com Edit opam file Versions (19)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.14.3.tar.gz

sha256=e34dc0dd052a386c84f5f67e71a90720dff76e0edd01f431604404bee86ebe5a

doc/base/Base/Field/index.html

Module `Base.Field`

OCaml record field.

type ('perm, 'record, 'field) t_with_perm =

| Field of ('perm, 'record, 'field) For_generated_code.t

'record is the type of the record. 'field is the type of the values stored in the record field with name name. 'perm is a way of restricting the operations that can be used.

type ('record, 'field) t =
  ([ `Read | `Set_and_create ], 'record, 'field) t_with_perm

A record field with no restrictions.

type ('record, 'field) readonly_t = ([ `Read ], 'record, 'field) t_with_perm

A record that can only be read, because it belongs to a private type.

val name : (_, _, _) t_with_perm -> string

val get : (_, 'r, 'a) t_with_perm -> 'r -> 'a

val fset : ([> `Set_and_create ], 'r, 'a) t_with_perm -> 'r -> 'a -> 'r

val setter : 
  ([> `Set_and_create ], 'r, 'a) t_with_perm ->
  ('r -> 'a -> unit) option

val map : 
  ([> `Set_and_create ], 'r, 'a) t_with_perm ->
  'r ->
  f:('a -> 'a) ->
  'r

val updater : 
  ([> `Set_and_create ], 'r, 'a) t_with_perm ->
  ('r -> f:('a -> 'a) -> unit) option

type ('perm, 'record, 'result) user = {

f : 'field. ('perm, 'record, 'field) t_with_perm -> 'result;

}