package core

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

Module Shape.Flag_infoSource

Sourcetype t = {
  1. name : Base.String.t;
    (*

    See flag_name below.

    *)
  2. doc : Base.String.t;
  3. aliases : Base.String.t Base.List.t;
}
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
Sourceval doc : t -> Base.String.t
Sourceval name : t -> Base.String.t
Sourcemodule Fields : sig ... end
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval flag_name : t -> Base.String.t Or_error.t

flag_name infers the string which one would pass on the command line. It is not the same as the raw name field, which additionally encodes num_occurrences and requires_arg (sort of).

Sourceval num_occurrences : t -> Num_occurrences.t Or_error.t
Sourceval requires_arg : t -> Base.Bool.t Or_error.t

requires_arg gives undefined behavior on escape flags. This is a limitation of the underlying shape representation.

  • deprecated [since 2020-04] Use [Command.Stable.Shape.Flag_info].
include Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t
Sourceval t_of_sexp : Sexp.t -> t
  • deprecated [since 2020-04] Use [Command.Stable.Shape.Flag_info].
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