From d7985d42e4157fc80b876c1d3bed3c0fcc18f61a Mon Sep 17 00:00:00 2001 From: Nathan Rebours Date: Mon, 15 Apr 2024 11:02:20 +0200 Subject: [PATCH] Update ppx_deriving doc to 6.0.0. --- index.html | 2 +- ppx_deriving/Ppx_deriving/Arg/index.html | 2 +- ppx_deriving/Ppx_deriving_fold/index.html | 2 +- ppx_deriving/Ppx_deriving_iter/index.html | 2 +- ppx_deriving/Ppx_deriving_make/index.html | 40 ++++++++++++++++--- ppx_deriving/Ppx_deriving_map/index.html | 2 +- .../Ppx_deriving_runtime/Result/index.html | 2 - ppx_deriving/Ppx_deriving_runtime/index.html | 2 +- ppx_deriving/Ppx_deriving_show/index.html | 8 ++-- 9 files changed, 45 insertions(+), 17 deletions(-) delete mode 100644 ppx_deriving/Ppx_deriving_runtime/Result/index.html diff --git a/index.html b/index.html index 79ce05b..bf50a20 100644 --- a/index.html +++ b/index.html @@ -11,7 +11,7 @@

OCaml package documentation

    -
  1. ppx_deriving 5.3.0
    2. +
  2. ppx_deriving 6.0.0
diff --git a/ppx_deriving/Ppx_deriving/Arg/index.html b/ppx_deriving/Ppx_deriving/Arg/index.html index fdec45c..85dfc37 100644 --- a/ppx_deriving/Ppx_deriving/Arg/index.html +++ b/ppx_deriving/Ppx_deriving/Arg/index.html @@ -1,5 +1,5 @@ -Arg (ppx_deriving.Ppx_deriving.Arg)

Module Ppx_deriving.Arg

Arg contains convenience functions that extract constants from AST fragments, to be used when parsing options or [\@attributes] attached to types, fields or constructors.

The ~name argument is used in error messages and should receive the name of the deriving plugin, e.g. "show".

type 'a conv = Ppxlib.expression -> ('a, string) Result.result

A type of conversion functions.

A conversion function of type 'a conv converts a raw expression into an argument of type 'a. Or returns Result.Error "error" if conversion fails.

val expr : Ppxlib.expression conv

expr returns the input expression as-is.

val bool : bool conv

bool expr extracts a boolean constant from expr, or returns Result.Error "boolean" if expr does not contain a boolean literal.

val int : int conv

int expr extracts an integer constant from expr, or returns Result.Error "integer" if expr does not contain an integer literal.

val string : string conv

string expr extracts a string constant from expr, or returns Result.Error "string" if expr does not contain a string literal.

val char : char conv

char expr extracts a char constant from expr, or returns Result.Error "char" if expr does not contain a char literal.

val enum : string list -> string conv

enum values expr extracts a polymorphic variant constant from expr, or returns Result.Error "one of: `a, `b, ..." if expr does not contain a polymorphic variant constructor included in values.

val list : 'a conv -> 'a list conv

list f expr extracts a list constant from expr and maps every element through f, or returns Result.Error "list:..." where ... is the error returned by f, or returns Result.Error "list" if expr does not contain a list.

val get_attr : +Arg (ppx_deriving.Ppx_deriving.Arg)

Module Ppx_deriving.Arg

Arg contains convenience functions that extract constants from AST fragments, to be used when parsing options or [\@attributes] attached to types, fields or constructors.

The ~name argument is used in error messages and should receive the name of the deriving plugin, e.g. "show".

type 'a conv = Ppxlib.expression -> ('a, string) Stdlib.result

A type of conversion functions.

A conversion function of type 'a conv converts a raw expression into an argument of type 'a. Or returns Error "error" if conversion fails.

val expr : Ppxlib.expression conv

expr returns the input expression as-is.

val bool : bool conv

bool expr extracts a boolean constant from expr, or returns Error "boolean" if expr does not contain a boolean literal.

val int : int conv

int expr extracts an integer constant from expr, or returns Error "integer" if expr does not contain an integer literal.

val string : string conv

string expr extracts a string constant from expr, or returns Error "string" if expr does not contain a string literal.

val char : char conv

char expr extracts a char constant from expr, or returns Error "char" if expr does not contain a char literal.

val enum : string list -> string conv

enum values expr extracts a polymorphic variant constant from expr, or returns Error "one of: `a, `b, ..." if expr does not contain a polymorphic variant constructor included in values.

val list : 'a conv -> 'a list conv

list f expr extracts a list constant from expr and maps every element through f, or returns Error "list:..." where ... is the error returned by f, or returns Error "list" if expr does not contain a list.

val get_attr : deriver:string -> 'a conv -> Ppxlib.attribute option -> diff --git a/ppx_deriving/Ppx_deriving_fold/index.html b/ppx_deriving/Ppx_deriving_fold/index.html index f3ae396..b2316c7 100644 --- a/ppx_deriving/Ppx_deriving_fold/index.html +++ b/ppx_deriving/Ppx_deriving_fold/index.html @@ -20,4 +20,4 @@ Ppxlib__Deriving.Generator.t
val intf_generator : (Astlib.Ast_500.Parsetree.signature_item list, Ppxlib__.Import.rec_flag * Ppxlib.Parsetree.type_declaration list) - Ppxlib__Deriving.Generator.t
val deriving : Ppxlib.Deriving.t
val derive_extension : Ppxlib.Extension.V3.t
val derive_transformation : unit
+ Ppxlib__Deriving.Generator.t
val deriving : Ppxlib.Deriving.t
diff --git a/ppx_deriving/Ppx_deriving_iter/index.html b/ppx_deriving/Ppx_deriving_iter/index.html index 65e474e..1a0ed85 100644 --- a/ppx_deriving/Ppx_deriving_iter/index.html +++ b/ppx_deriving/Ppx_deriving_iter/index.html @@ -17,4 +17,4 @@ Ppxlib__Deriving.Generator.t
val intf_generator : (Astlib.Ast_500.Parsetree.signature_item list, Ppxlib__.Import.rec_flag * Ppxlib.type_declaration list) - Ppxlib__Deriving.Generator.t
val deriving : Ppxlib.Deriving.t
val derive_extension : Ppxlib.Extension.V3.t
val derive_transformation : unit
+ Ppxlib__Deriving.Generator.t
val deriving : Ppxlib.Deriving.t
diff --git a/ppx_deriving/Ppx_deriving_make/index.html b/ppx_deriving/Ppx_deriving_make/index.html index c397c34..d8ed0da 100644 --- a/ppx_deriving/Ppx_deriving_make/index.html +++ b/ppx_deriving/Ppx_deriving_make/index.html @@ -6,18 +6,46 @@ 'a
val attr_default : (Ppxlib__.Import.label_declaration, Ppxlib__.Import.expression) Ppxlib.Attribute.t - * (Ppxlib__.Import.core_type, Ppxlib__.Import.expression) Ppxlib.Attribute.t
val attr_split : 'a Ppxlib.Attribute.Context.t -> 'a Ppxlib.Attribute.flag
val ct_attr_split : Ppxlib__.Import.core_type Ppxlib.Attribute.flag
val label_attr_split : Ppxlib__.Import.label_declaration Ppxlib.Attribute.flag
val attr_main : 'a Ppxlib.Attribute.Context.t -> 'a Ppxlib.Attribute.flag
val ct_attr_main : Ppxlib__.Import.core_type Ppxlib.Attribute.flag
val label_attr_main : Ppxlib__.Import.label_declaration Ppxlib.Attribute.flag
val get_label_attribute : + * (Ppxlib__.Import.core_type, Ppxlib__.Import.expression) Ppxlib.Attribute.t
val mk_attr_split : 'a Ppxlib.Attribute.Context.t -> 'a Ppxlib.Attribute.flag
val ct_attr_split : Ppxlib__.Import.core_type Ppxlib.Attribute.flag
val label_attr_split : Ppxlib__.Import.label_declaration Ppxlib.Attribute.flag
val attr_split : + Ppxlib__.Import.label_declaration Ppxlib.Attribute.flag + * Ppxlib__.Import.core_type Ppxlib.Attribute.flag
val mk_attr_main : 'a Ppxlib.Attribute.Context.t -> 'a Ppxlib.Attribute.flag
val ct_attr_main : Ppxlib__.Import.core_type Ppxlib.Attribute.flag
val label_attr_main : Ppxlib__.Import.label_declaration Ppxlib.Attribute.flag
val attr_main : + Ppxlib__.Import.label_declaration Ppxlib.Attribute.flag + * Ppxlib__.Import.core_type Ppxlib.Attribute.flag
val get_label_attribute : ((Ppxlib.Parsetree.label_declaration, 'a) Ppxlib.Attribute.t * (Ppxlib.Parsetree.core_type, 'b) Ppxlib.Attribute.t) -> Ppxlib.Parsetree.label_declaration -> - 'c option
val find_main : + 'c option
val has_label_flag : + (Ppxlib.Parsetree.label_declaration Ppxlib.Attribute.flag + * Ppxlib.Parsetree.core_type Ppxlib.Attribute.flag) -> + Ppxlib.Parsetree.label_declaration -> + bool
val find_main : + Ppxlib.Parsetree.label_declaration list -> + (Ppxlib.Parsetree.label_declaration option + * Ppxlib.Parsetree.label_declaration list, + Ppxlib__.Import.extension) + Stdlib.result
val is_optional : Ppxlib.Parsetree.label_declaration -> bool
val add_str_label_arg : + quoter:Ppx_deriving.quoter -> + loc:Astlib__.Location.t -> + Astlib.Ast_500.Parsetree.expression -> + Ppxlib.Parsetree.label_declaration -> + Astlib.Ast_500.Parsetree.expression
val str_of_record_type : + quoter:Ppx_deriving.quoter -> + loc:Ppxlib__.Import.location -> Ppxlib.Parsetree.label_declaration list -> - Ppxlib.Parsetree.label_declaration option - * Ppxlib.Parsetree.label_declaration list
val is_optional : Ppxlib.Parsetree.label_declaration -> bool
val str_of_type : + Ppxlib__.Import.expression
val str_of_type : Ppxlib.Parsetree.type_declaration -> - Astlib.Ast_500.Parsetree.value_binding list
val wrap_predef_option : 'a -> 'b
val sig_of_type : + (Astlib.Ast_500.Parsetree.value_binding, Ppxlib__.Import.extension) + Stdlib.result
val wrap_predef_option : 'a -> 'b
val add_sig_label_arg : + Astlib.Ast_500.Parsetree.core_type -> + Ppxlib.Parsetree.label_declaration -> + Astlib.Ast_500.Parsetree.core_type
val sig_of_record_type : + loc:Ppxlib__.Import.location -> + typ:Astlib.Ast_500.Parsetree.core_type -> + Ppxlib.Parsetree.label_declaration list -> + Ppxlib__.Import.core_type
val sig_of_type : Ppxlib.Parsetree.type_declaration -> - Astlib.Ast_500.Parsetree.signature_item list
val impl_generator : + (Astlib.Ast_500.Parsetree.signature_item, Ppxlib__.Import.extension) + Stdlib.result
val partition_result : ('a, 'b) Stdlib.result list -> 'c list * 'd list
val impl_generator : (Astlib.Ast_500.Parsetree.structure_item list, Ppxlib__.Import.rec_flag * Ppxlib.Parsetree.type_declaration list) Ppxlib__Deriving.Generator.t
val intf_generator : diff --git a/ppx_deriving/Ppx_deriving_map/index.html b/ppx_deriving/Ppx_deriving_map/index.html index 466be57..65f8d9d 100644 --- a/ppx_deriving/Ppx_deriving_map/index.html +++ b/ppx_deriving/Ppx_deriving_map/index.html @@ -24,4 +24,4 @@ Ppxlib__Deriving.Generator.t
val intf_generator : (Astlib.Ast_500.Parsetree.signature_item list, Ppxlib__.Import.rec_flag * Ppxlib.Parsetree.type_declaration list) - Ppxlib__Deriving.Generator.t
val deriving : Ppxlib.Deriving.t
val derive_extension : Ppxlib.Extension.V3.t
val derive_transformation : unit
+ Ppxlib__Deriving.Generator.t
val deriving : Ppxlib.Deriving.t
diff --git a/ppx_deriving/Ppx_deriving_runtime/Result/index.html b/ppx_deriving/Ppx_deriving_runtime/Result/index.html deleted file mode 100644 index 67144d8..0000000 --- a/ppx_deriving/Ppx_deriving_runtime/Result/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Result (ppx_deriving.Ppx_deriving_runtime.Result)

Module Ppx_deriving_runtime.Result

type ('a, 'b) t = ('a, 'b) result =
  1. | Ok of 'a
  2. | Error of 'b
type ('a, 'b) result = ('a, 'b) t =
  1. | Ok of 'a
  2. | Error of 'b
diff --git a/ppx_deriving/Ppx_deriving_runtime/index.html b/ppx_deriving/Ppx_deriving_runtime/index.html index 8716953..51a08ed 100644 --- a/ppx_deriving/Ppx_deriving_runtime/index.html +++ b/ppx_deriving/Ppx_deriving_runtime/index.html @@ -5,4 +5,4 @@ ('a, 'b, 'c, 'd, 'e, 'f) format6
val (^^) : ('a, 'b, 'c, 'd, 'e, 'f) format6 -> ('f, 'b, 'c, 'e, 'g, 'h) format6 -> - ('a, 'b, 'c, 'd, 'g, 'h) format6
val exit : int -> 'a
val at_exit : (unit -> unit) -> unit
val valid_float_lexem : string -> string
val unsafe_really_input : in_channel -> bytes -> int -> int -> unit
val do_at_exit : unit -> unit
module Arg : sig ... end
module Array : sig ... end
module ArrayLabels : sig ... end
module Atomic : sig ... end
module Bigarray : sig ... end
module Bool : sig ... end
module Buffer : sig ... end
module Bytes : sig ... end
module BytesLabels : sig ... end
module Callback : sig ... end
module Char : sig ... end
module Complex : sig ... end
module Digest : sig ... end
module Either : sig ... end
module Ephemeron : sig ... end
module Filename : sig ... end
module Float : sig ... end
module Format : sig ... end
module Fun : sig ... end
module Gc : sig ... end
module Genlex : sig ... end
module Hashtbl : sig ... end
module In_channel : sig ... end
module Int : sig ... end
module Int32 : sig ... end
module Int64 : sig ... end
module Lazy : sig ... end
module Lexing : sig ... end
module List : sig ... end
module ListLabels : sig ... end
module Map : sig ... end
module Marshal : sig ... end
module MoreLabels : sig ... end
module Nativeint : sig ... end
module Obj : sig ... end
module Oo : sig ... end
module Option : sig ... end
module Out_channel : sig ... end
module Parsing : sig ... end
module Pervasives : sig ... end
module Printexc : sig ... end
module Printf : sig ... end
module Queue : sig ... end
module Random : sig ... end
module Scanf : sig ... end
module Seq : sig ... end
module Set : sig ... end
module Stack : sig ... end
module StdLabels : sig ... end
module Stream : sig ... end
module String : sig ... end
module StringLabels : sig ... end
module Sys : sig ... end
module Uchar : sig ... end
module Unit : sig ... end
module Weak : sig ... end
module Stdlib = Stdlib
module Result : sig ... end
+ ('a, 'b, 'c, 'd, 'g, 'h) format6
val exit : int -> 'a
val at_exit : (unit -> unit) -> unit
val valid_float_lexem : string -> string
val unsafe_really_input : in_channel -> bytes -> int -> int -> unit
val do_at_exit : unit -> unit
module Arg : sig ... end
module Array : sig ... end
module ArrayLabels : sig ... end
module Atomic : sig ... end
module Bigarray : sig ... end
module Bool : sig ... end
module Buffer : sig ... end
module Bytes : sig ... end
module BytesLabels : sig ... end
module Callback : sig ... end
module Char : sig ... end
module Complex : sig ... end
module Digest : sig ... end
module Either : sig ... end
module Ephemeron : sig ... end
module Filename : sig ... end
module Float : sig ... end
module Format : sig ... end
module Fun : sig ... end
module Gc : sig ... end
module Genlex : sig ... end
module Hashtbl : sig ... end
module In_channel : sig ... end
module Int : sig ... end
module Int32 : sig ... end
module Int64 : sig ... end
module Lazy : sig ... end
module Lexing : sig ... end
module List : sig ... end
module ListLabels : sig ... end
module Map : sig ... end
module Marshal : sig ... end
module MoreLabels : sig ... end
module Nativeint : sig ... end
module Obj : sig ... end
module Oo : sig ... end
module Option : sig ... end
module Out_channel : sig ... end
module Parsing : sig ... end
module Pervasives : sig ... end
module Printexc : sig ... end
module Printf : sig ... end
module Queue : sig ... end
module Random : sig ... end
module Result : sig ... end
module Scanf : sig ... end
module Seq : sig ... end
module Set : sig ... end
module Stack : sig ... end
module StdLabels : sig ... end
module Stream : sig ... end
module String : sig ... end
module StringLabels : sig ... end
module Sys : sig ... end
module Uchar : sig ... end
module Unit : sig ... end
module Weak : sig ... end
module Stdlib = Stdlib
diff --git a/ppx_deriving/Ppx_deriving_show/index.html b/ppx_deriving/Ppx_deriving_show/index.html index 520290a..9df02f7 100644 --- a/ppx_deriving/Ppx_deriving_show/index.html +++ b/ppx_deriving/Ppx_deriving_show/index.html @@ -26,12 +26,14 @@ with_path:bool -> path:string list -> Ppxlib.Parsetree.type_declaration -> - Astlib.Ast_500.Parsetree.value_binding list
val args : + Astlib.Ast_500.Parsetree.value_binding list
val impl_args : (bool option -> Ppxlib__.Import.structure, Ppxlib__.Import.structure) Ppxlib.Deriving.Args.t
val impl_generator : (Ppxlib__.Import.structure, Ppxlib__.Import.rec_flag * Ppxlib.Parsetree.type_declaration list) - Ppxlib__Deriving.Generator.t
val intf_generator : - (Astlib.Ast_500.Parsetree.signature_item list, + Ppxlib__Deriving.Generator.t
val intf_args : + (bool option -> Ppxlib__.Import.signature, Ppxlib__.Import.signature) + Ppxlib.Deriving.Args.t
val intf_generator : + (Ppxlib__.Import.signature, Ppxlib__.Import.rec_flag * Ppxlib.type_declaration list) Ppxlib__Deriving.Generator.t
val deriving : Ppxlib.Deriving.t
val derive_extension : Ppxlib.Extension.V3.t
val derive_transformation : unit