package data-encoding
Library of JSON and binary encoding combinators
Install
Dune Dependency
Authors
Maintainers
Sources
data-encoding-v0.4.tar.gz
md5=7b687e25619637d40d2bbcd2c21b00c2
sha512=65e33b1a56e9058a2e9c7f3dc18cb72c21270e0e5b9584fe856285d16e4cb8e98adac826373d4109a5e080486ec31cdd9870b402249ac5d55c7b0de6ffb68b0a
doc/src/data-encoding/encoding.ml.html
Source file encoding.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
(*****************************************************************************) (* *) (* Open Source License *) (* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *) (* Copyright (c) 2020 Nomadic Labs, <contact@nomadic-labs.com> *) (* *) (* Permission is hereby granted, free of charge, to any person obtaining a *) (* copy of this software and associated documentation files (the "Software"),*) (* to deal in the Software without restriction, including without limitation *) (* the rights to use, copy, modify, merge, publish, distribute, sublicense, *) (* and/or sell copies of the Software, and to permit persons to whom the *) (* Software is furnished to do so, subject to the following conditions: *) (* *) (* The above copyright notice and this permission notice shall be included *) (* in all copies or substantial portions of the Software. *) (* *) (* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*) (* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *) (* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *) (* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*) (* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *) (* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *) (* DEALINGS IN THE SOFTWARE. *) (* *) (*****************************************************************************) module Kind = struct type t = [`Fixed of int | `Dynamic | `Variable] type length = [`Fixed of int | `Variable] type enum = [`Dynamic | `Variable] let combine name : t -> t -> t = fun k1 k2 -> match (k1, k2) with | (`Fixed n1, `Fixed n2) -> `Fixed (n1 + n2) | (`Dynamic, `Dynamic) | (`Fixed _, `Dynamic) | (`Dynamic, `Fixed _) -> `Dynamic | (`Variable, `Fixed _) | ((`Dynamic | `Fixed _), `Variable) -> `Variable | (`Variable, `Dynamic) -> Printf.ksprintf invalid_arg "Cannot merge two %s when the left element is of variable length and \ the right one of dynamic length. You should use the reverse order, \ or wrap the second one with Data_encoding.dynamic_size." name | (`Variable, `Variable) -> Printf.ksprintf invalid_arg "Cannot merge two %s with variable length. You should wrap one of \ them with Data_encoding.dynamic_size." name let merge : t -> t -> t = fun k1 k2 -> match (k1, k2) with | (`Fixed n1, `Fixed n2) when n1 = n2 -> `Fixed n1 | (`Fixed _, `Fixed _) -> `Dynamic | (`Dynamic, `Dynamic) | (`Fixed _, `Dynamic) | (`Dynamic, `Fixed _) -> `Dynamic | (`Variable, (`Dynamic | `Fixed _)) | ((`Dynamic | `Fixed _), `Variable) | (`Variable, `Variable) -> `Variable let merge_list sz : t list -> t = function | [] -> assert false (* should be rejected by Data_encoding.union *) | k :: ks -> ( match List.fold_left merge k ks with | `Fixed n -> `Fixed (n + Binary_size.tag_size sz) | k -> k ) end type case_tag = Tag of int | Json_only (* [case_tag_internal] is an optimised representation of case_tag. The idea is to encode values of type [case_tag] to remove a level of indirection. *) type case_tag_internal = Uint_option.t let json_only = Uint_option.none let make_tag = Uint_option.some let is_tag = Uint_option.is_some let get_tag = Uint_option.get type 'a desc = | Null : unit desc | Empty : unit desc | Ignore : unit desc | Constant : string -> unit desc | Bool : bool desc | Int8 : int desc | Uint8 : int desc | Int16 : int desc | Uint16 : int desc | Int31 : int desc | Int32 : Int32.t desc | Int64 : Int64.t desc | N : Z.t desc | Z : Z.t desc | RangedInt : {minimum: int; maximum: int} -> int desc | RangedFloat : {minimum: float; maximum: float} -> float desc | Float : float desc | Bytes : Kind.length -> Bytes.t desc | String : Kind.length -> string desc | Padded : 'a t * int -> 'a desc | String_enum : ('a, string * int) Hashtbl.t * 'a array -> 'a desc | Array : int option * 'a t -> 'a array desc | List : int option * 'a t -> 'a list desc | Obj : 'a field -> 'a desc | Objs : {kind: Kind.t; left: 'a t; right: 'b t} -> ('a * 'b) desc | Tup : 'a t -> 'a desc | Tups : {kind: Kind.t; left: 'a t; right: 'b t} -> ('a * 'b) desc | Union : { kind: Kind.t; tag_size: Binary_size.tag_size; tagged_cases: 'a case array; match_case: 'a -> match_result; cases: 'a case list; } -> 'a desc | Mu : { kind: Kind.enum; name: string; title: string option; description: string option; fix: 'a t -> 'a t; } -> 'a desc | Conv : { proj: 'a -> 'b; inj: 'b -> 'a; encoding: 'b t; schema: Json_schema.schema option; } -> 'a desc | Describe : { id: string; title: string option; description: string option; encoding: 'a t; } -> 'a desc | Splitted : { encoding: 'a t; json_encoding: 'a Json_encoding.encoding; is_obj: bool; is_tup: bool; } -> 'a desc | Dynamic_size : { kind: Binary_size.unsigned_integer; encoding: 'a t; } -> 'a desc | Check_size : {limit: int; encoding: 'a t} -> 'a desc | Delayed : (unit -> 'a t) -> 'a desc and _ field = | Req : { name: string; encoding: 'a t; title: string option; description: string option; } -> 'a field | Opt : { name: string; kind: Kind.enum; encoding: 'a t; title: string option; description: string option; } -> 'a option field | Dft : { name: string; encoding: 'a t; default: 'a; title: string option; description: string option; } -> 'a field and 'a case = | Case : { title: string; description: string option; encoding: 'a t; proj: 't -> 'a option; inj: 'a -> 't; tag: case_tag_internal; } -> 't case and match_result = Matched : int * 'b t * 'b -> match_result and 'a t = { encoding: 'a desc; mutable json_encoding: 'a Json_encoding.encoding option; } type 'a encoding = 'a t let rec classify : type a. a t -> Kind.t = fun e -> classify_desc e.encoding and classify_desc : type a. a desc -> Kind.t = fun e -> match e with (* Fixed *) | Null -> `Fixed 0 | Empty -> `Fixed 0 | Constant _ -> `Fixed 0 | Bool -> `Fixed Binary_size.bool | Int8 -> `Fixed Binary_size.int8 | Uint8 -> `Fixed Binary_size.uint8 | Int16 -> `Fixed Binary_size.int16 | Uint16 -> `Fixed Binary_size.uint16 | Int31 -> `Fixed Binary_size.int31 | Int32 -> `Fixed Binary_size.int32 | Int64 -> `Fixed Binary_size.int64 | N -> `Dynamic | Z -> `Dynamic | RangedInt {minimum; maximum} -> `Fixed Binary_size.(integer_to_size @@ range_to_size ~minimum ~maximum) | Float -> `Fixed Binary_size.float | RangedFloat _ -> `Fixed Binary_size.float (* Tagged *) | Bytes kind -> (kind :> Kind.t) | String kind -> (kind :> Kind.t) | Padded ({encoding; _}, n) -> ( match classify_desc encoding with | `Fixed m -> `Fixed (n + m) | _ -> assert false (* by construction (see [Fixed.padded]) *) ) | String_enum (_, cases) -> `Fixed Binary_size.(integer_to_size @@ enum_size cases) | Obj (Opt {kind; _}) -> (kind :> Kind.t) | Objs {kind; _} -> kind | Tups {kind; _} -> kind | Union {kind; _} -> (kind :> Kind.t) | Mu {kind; _} -> (kind :> Kind.t) (* Variable *) | Ignore -> `Fixed 0 | Array _ -> `Variable | List _ -> `Variable (* Recursive *) | Obj (Req {encoding; _}) -> classify encoding | Obj (Dft {encoding; _}) -> classify encoding | Tup encoding -> classify encoding | Conv {encoding; _} -> classify encoding | Describe {encoding; _} -> classify encoding | Splitted {encoding; _} -> classify encoding | Dynamic_size _ -> `Dynamic | Check_size {encoding; _} -> classify encoding | Delayed f -> classify (f ()) let make ?json_encoding encoding = {encoding; json_encoding} module Fixed = struct let string n = if n <= 0 then invalid_arg "Cannot create a string encoding of negative or null fixed length."; make @@ String (`Fixed n) let bytes n = if n <= 0 then invalid_arg "Cannot create a byte encoding of negative or null fixed length."; make @@ Bytes (`Fixed n) let add_padding e n = if n <= 0 then invalid_arg "Cannot create a padding of negative or null fixed length."; match classify e with | `Fixed _ -> make @@ Padded (e, n) | _ -> invalid_arg "Cannot pad non-fixed size encoding" end let rec is_zeroable : type t. t encoding -> bool = fun e -> (* Whether an encoding can ever produce zero-byte of encoding. It is dangerous to place zero-size elements in a collection (list/array) because they are indistinguishable from the absence of elements. *) match e.encoding with (* trivially true *) | Null -> true (* always true *) | Empty -> true (* always true *) | Ignore -> true (* always true *) | Constant _ -> true (* always true *) (* trivially false *) | Bool -> false | Int8 -> false | Uint8 -> false | Int16 -> false | Uint16 -> false | Int31 -> false | Int32 -> false | Int64 -> false | N -> false | Z -> false | RangedInt _ -> false | RangedFloat _ -> false | Float -> false | Bytes _ -> false | String _ -> false | Padded _ -> false | String_enum _ -> false (* true in some cases, but in practice always protected by Dynamic *) | Array _ -> true (* 0-element array *) | List _ -> true (* 0-element list *) (* represented as whatever is inside: truth mostly propagates *) | Obj (Req {encoding = e; _}) -> is_zeroable e (* represented as-is *) | Obj (Opt {kind = `Variable; _}) -> true (* optional field omitted *) | Obj (Dft {encoding = e; _}) -> is_zeroable e (* represented as-is *) | Obj _ -> false | Objs {left; right; _} -> is_zeroable left && is_zeroable right | Tup e -> is_zeroable e | Tups {left; right; _} -> is_zeroable left && is_zeroable right | Union _ -> false (* includes a tag *) (* other recursive cases: truth propagates *) | Mu {kind = `Dynamic; _} -> false (* size prefix *) | Mu {kind = `Variable; fix; _} -> is_zeroable (fix e) | Conv {encoding; _} -> is_zeroable encoding | Describe {encoding; _} -> is_zeroable encoding | Splitted {encoding; _} -> is_zeroable encoding | Check_size {encoding; _} -> is_zeroable encoding (* Unscrutable: true by default *) | Delayed f -> is_zeroable (f ()) (* Protected against zeroable *) | Dynamic_size _ -> false (* always some data for size *) module Variable = struct let string = make @@ String `Variable let bytes = make @@ Bytes `Variable let check_not_variable name e = match classify e with | `Variable -> Printf.ksprintf invalid_arg "Cannot insert variable length element in %s. You should wrap the \ contents using Data_encoding.dynamic_size." name | `Dynamic | `Fixed _ -> () let check_not_zeroable name e = if is_zeroable e then Printf.ksprintf invalid_arg "Cannot insert potentially zero-sized element in %s." name else () let array ?max_length e = check_not_variable "an array" e; check_not_zeroable "an array" e; let encoding = make @@ Array (max_length, e) in match (classify e, max_length) with | (`Fixed n, Some max_length) -> let limit = n * max_length in make @@ Check_size {limit; encoding} | (_, _) -> encoding let list ?max_length e = check_not_variable "a list" e; check_not_zeroable "a list" e; let encoding = make @@ List (max_length, e) in match (classify e, max_length) with | (`Fixed n, Some max_length) -> let limit = n * max_length in make @@ Check_size {limit; encoding} | (_, _) -> encoding end let dynamic_size ?(kind = `Uint30) e = make @@ Dynamic_size {kind; encoding = e} let check_size limit encoding = make @@ Check_size {limit; encoding} let delayed f = make @@ Delayed f let null = make @@ Null let empty = make @@ Empty let unit = make @@ Ignore let constant s = make @@ Constant s let bool = make @@ Bool let int8 = make @@ Int8 let uint8 = make @@ Uint8 let int16 = make @@ Int16 let uint16 = make @@ Uint16 let int31 = make @@ Int31 let int32 = make @@ Int32 let ranged_int minimum maximum = let minimum = min minimum maximum and maximum = max minimum maximum in if minimum < -(1 lsl 30) || (1 lsl 30) - 1 < maximum then invalid_arg "Data_encoding.ranged_int"; make @@ RangedInt {minimum; maximum} let ranged_float minimum maximum = let minimum = min minimum maximum and maximum = max minimum maximum in make @@ RangedFloat {minimum; maximum} let int64 = make @@ Int64 let n = make @@ N let z = make @@ Z let float = make @@ Float let string = dynamic_size Variable.string let bytes = dynamic_size Variable.bytes let array ?max_length e = dynamic_size (Variable.array ?max_length e) let list ?max_length e = dynamic_size (Variable.list ?max_length e) let string_enum = function | [] -> invalid_arg "data_encoding.string_enum: cannot have zero cases" | [_case] -> invalid_arg "data_encoding.string_enum: cannot have a single case, use constant \ instead" | _ :: _ as cases -> let arr = Array.of_list (List.map snd cases) in let tbl = Hashtbl.create (Array.length arr) in List.iteri (fun ind (str, a) -> Hashtbl.add tbl a (str, ind)) cases; make @@ String_enum (tbl, arr) let conv proj inj ?schema encoding = make @@ Conv {proj; inj; encoding; schema} let conv_with_guard proj inj_guard ?schema encoding = let inj x = match inj_guard x with | Ok y -> y | Error s -> raise (Binary_error_types.Invariant_guard s) in conv proj inj ?schema encoding let with_decoding_guard guard encoding = conv (fun x -> x) (fun y -> match guard y with | Ok () -> y | Error s -> raise (Binary_error_types.Invariant_guard s)) encoding let def id ?title ?description encoding = make @@ Describe {id; title; description; encoding} let req ?title ?description n t = Req {name = n; encoding = t; title; description} let opt ?title ?description n encoding = let kind = match classify encoding with | `Variable -> `Variable | `Fixed _ | `Dynamic -> `Dynamic in Opt {name = n; kind; encoding; title; description} let varopt ?title ?description n encoding = Opt {name = n; kind = `Variable; encoding; title; description} let dft ?title ?description n t d = Dft {name = n; encoding = t; default = d; title; description} let raw_splitted ~json ~binary = make @@ Splitted {encoding = binary; json_encoding = json; is_obj = false; is_tup = false} let rec is_obj : type a. a t -> bool = fun e -> match e.encoding with | Obj _ -> true | Objs _ (* by construction *) -> true | Conv {encoding = e; _} -> is_obj e | Dynamic_size {encoding = e; _} -> is_obj e | Union {cases; _} -> List.for_all (fun (Case {encoding = e; _}) -> is_obj e) cases | Empty -> true | Ignore -> true | Mu {fix; _} -> is_obj (fix e) | Splitted {is_obj; _} -> is_obj | Delayed f -> is_obj (f ()) | Describe {encoding; _} -> is_obj encoding | _ -> false let rec is_tup : type a. a t -> bool = fun e -> match e.encoding with | Tup _ -> true | Tups _ (* by construction *) -> true | Conv {encoding = e; _} -> is_tup e | Dynamic_size {encoding = e; _} -> is_tup e | Union {cases; _} -> List.for_all (function Case {encoding = e; _} -> is_tup e) cases | Mu {fix; _} -> is_tup (fix e) | Splitted {is_tup; _} -> is_tup | Delayed f -> is_tup (f ()) | Describe {encoding; _} -> is_tup encoding | _ -> false let raw_merge_objs left right = let kind = Kind.combine "objects" (classify left) (classify right) in make @@ Objs {kind; left; right} let obj1 f1 = make @@ Obj f1 let obj2 f2 f1 = raw_merge_objs (obj1 f2) (obj1 f1) let obj3 f3 f2 f1 = raw_merge_objs (obj1 f3) (obj2 f2 f1) let obj4 f4 f3 f2 f1 = raw_merge_objs (obj2 f4 f3) (obj2 f2 f1) let obj5 f5 f4 f3 f2 f1 = raw_merge_objs (obj1 f5) (obj4 f4 f3 f2 f1) let obj6 f6 f5 f4 f3 f2 f1 = raw_merge_objs (obj2 f6 f5) (obj4 f4 f3 f2 f1) let obj7 f7 f6 f5 f4 f3 f2 f1 = raw_merge_objs (obj3 f7 f6 f5) (obj4 f4 f3 f2 f1) let obj8 f8 f7 f6 f5 f4 f3 f2 f1 = raw_merge_objs (obj4 f8 f7 f6 f5) (obj4 f4 f3 f2 f1) let obj9 f9 f8 f7 f6 f5 f4 f3 f2 f1 = raw_merge_objs (obj1 f9) (obj8 f8 f7 f6 f5 f4 f3 f2 f1) let obj10 f10 f9 f8 f7 f6 f5 f4 f3 f2 f1 = raw_merge_objs (obj2 f10 f9) (obj8 f8 f7 f6 f5 f4 f3 f2 f1) let merge_objs o1 o2 = if is_obj o1 && is_obj o2 then raw_merge_objs o1 o2 else invalid_arg "Json_encoding.merge_objs" let raw_merge_tups left right = let kind = Kind.combine "tuples" (classify left) (classify right) in make @@ Tups {kind; left; right} let tup1 e1 = make @@ Tup e1 let tup2 e2 e1 = raw_merge_tups (tup1 e2) (tup1 e1) let tup3 e3 e2 e1 = raw_merge_tups (tup1 e3) (tup2 e2 e1) let tup4 e4 e3 e2 e1 = raw_merge_tups (tup2 e4 e3) (tup2 e2 e1) let tup5 e5 e4 e3 e2 e1 = raw_merge_tups (tup1 e5) (tup4 e4 e3 e2 e1) let tup6 e6 e5 e4 e3 e2 e1 = raw_merge_tups (tup2 e6 e5) (tup4 e4 e3 e2 e1) let tup7 e7 e6 e5 e4 e3 e2 e1 = raw_merge_tups (tup3 e7 e6 e5) (tup4 e4 e3 e2 e1) let tup8 e8 e7 e6 e5 e4 e3 e2 e1 = raw_merge_tups (tup4 e8 e7 e6 e5) (tup4 e4 e3 e2 e1) let tup9 e9 e8 e7 e6 e5 e4 e3 e2 e1 = raw_merge_tups (tup1 e9) (tup8 e8 e7 e6 e5 e4 e3 e2 e1) let tup10 e10 e9 e8 e7 e6 e5 e4 e3 e2 e1 = raw_merge_tups (tup2 e10 e9) (tup8 e8 e7 e6 e5 e4 e3 e2 e1) let merge_tups t1 t2 = if is_tup t1 && is_tup t2 then raw_merge_tups t1 t2 else invalid_arg "Tezos_serial.Encoding.merge_tups" let conv3 ty = conv (fun (c, b, a) -> (c, (b, a))) (fun (c, (b, a)) -> (c, b, a)) ty let obj3 f3 f2 f1 = conv3 (obj3 f3 f2 f1) let tup3 f3 f2 f1 = conv3 (tup3 f3 f2 f1) let conv4 ty = conv (fun (d, c, b, a) -> ((d, c), (b, a))) (fun ((d, c), (b, a)) -> (d, c, b, a)) ty let obj4 f4 f3 f2 f1 = conv4 (obj4 f4 f3 f2 f1) let tup4 f4 f3 f2 f1 = conv4 (tup4 f4 f3 f2 f1) let conv5 ty = conv (fun (e, d, c, b, a) -> (e, ((d, c), (b, a)))) (fun (e, ((d, c), (b, a))) -> (e, d, c, b, a)) ty let obj5 f5 f4 f3 f2 f1 = conv5 (obj5 f5 f4 f3 f2 f1) let tup5 f5 f4 f3 f2 f1 = conv5 (tup5 f5 f4 f3 f2 f1) let conv6 ty = conv (fun (f, e, d, c, b, a) -> ((f, e), ((d, c), (b, a)))) (fun ((f, e), ((d, c), (b, a))) -> (f, e, d, c, b, a)) ty let obj6 f6 f5 f4 f3 f2 f1 = conv6 (obj6 f6 f5 f4 f3 f2 f1) let tup6 f6 f5 f4 f3 f2 f1 = conv6 (tup6 f6 f5 f4 f3 f2 f1) let conv7 ty = conv (fun (g, f, e, d, c, b, a) -> ((g, (f, e)), ((d, c), (b, a)))) (fun ((g, (f, e)), ((d, c), (b, a))) -> (g, f, e, d, c, b, a)) ty let obj7 f7 f6 f5 f4 f3 f2 f1 = conv7 (obj7 f7 f6 f5 f4 f3 f2 f1) let tup7 f7 f6 f5 f4 f3 f2 f1 = conv7 (tup7 f7 f6 f5 f4 f3 f2 f1) let conv8 ty = conv (fun (h, g, f, e, d, c, b, a) -> (((h, g), (f, e)), ((d, c), (b, a)))) (fun (((h, g), (f, e)), ((d, c), (b, a))) -> (h, g, f, e, d, c, b, a)) ty let obj8 f8 f7 f6 f5 f4 f3 f2 f1 = conv8 (obj8 f8 f7 f6 f5 f4 f3 f2 f1) let tup8 f8 f7 f6 f5 f4 f3 f2 f1 = conv8 (tup8 f8 f7 f6 f5 f4 f3 f2 f1) let conv9 ty = conv (fun (i, h, g, f, e, d, c, b, a) -> (i, (((h, g), (f, e)), ((d, c), (b, a))))) (fun (i, (((h, g), (f, e)), ((d, c), (b, a)))) -> (i, h, g, f, e, d, c, b, a)) ty let obj9 f9 f8 f7 f6 f5 f4 f3 f2 f1 = conv9 (obj9 f9 f8 f7 f6 f5 f4 f3 f2 f1) let tup9 f9 f8 f7 f6 f5 f4 f3 f2 f1 = conv9 (tup9 f9 f8 f7 f6 f5 f4 f3 f2 f1) let conv10 ty = conv (fun (j, i, h, g, f, e, d, c, b, a) -> ((j, i), (((h, g), (f, e)), ((d, c), (b, a))))) (fun ((j, i), (((h, g), (f, e)), ((d, c), (b, a)))) -> (j, i, h, g, f, e, d, c, b, a)) ty let obj10 f10 f9 f8 f7 f6 f5 f4 f3 f2 f1 = conv10 (obj10 f10 f9 f8 f7 f6 f5 f4 f3 f2 f1) let tup10 f10 f9 f8 f7 f6 f5 f4 f3 f2 f1 = conv10 (tup10 f10 f9 f8 f7 f6 f5 f4 f3 f2 f1) let undefined_encoding = delayed (fun _ -> assert false) let undefined_proj _ = None let undefined_inj _ = assert false let undefined_case : type a. a case = Case { title = "<YOU SHOULD NEVER SEE THAT>"; description = None; encoding = undefined_encoding; proj = undefined_proj; inj = undefined_inj; tag = Uint_option.none; } let is_undefined_case c = c == undefined_case let valid_tag tag_size t = let max_tag = Binary_size.max_int tag_size in if t > max_tag then Format.kasprintf invalid_arg "The tag %d is invalid because it should be less than %d." t max_tag let matching ?(tag_size = `Uint8) match_case cases = if cases = [] then invalid_arg "Data_encoding.union: empty list of cases."; let tagged_cases_list = List.filter (fun (Case {tag; _}) -> is_tag tag && ( valid_tag tag_size (get_tag tag); true )) cases in (* In [tagged_cases_list] all tags are [some] so [get] cannot fail *) let max_used_tag = List.fold_left (fun m (Case {tag; _}) -> max (Uint_option.get tag) m) (-1) tagged_cases_list in let tagged_cases = Array.make (max_used_tag + 1) undefined_case in List.iter (fun (Case {tag; _} as case) -> let tag = Uint_option.get tag in if not (is_undefined_case tagged_cases.(tag)) then Format.kasprintf invalid_arg "The tag %d appears twice in an union." tag; tagged_cases.(tag) <- case) tagged_cases_list; let classify_case (Case {encoding; _}) = classify encoding in let kinds = List.map classify_case cases in let kind = Kind.merge_list tag_size kinds in make @@ Union {kind; tag_size; tagged_cases; match_case; cases} let union ?(tag_size = `Uint8) cases = let match_case = let acases = Array.of_list @@ List.filter (fun (Case {tag; _}) -> is_tag tag) cases in fun x -> let rec find i = if i >= Array.length acases then raise Binary_error_types.(Write_error No_case_matched) else let (Case {tag; encoding; proj; _}) = acases.(i) in match proj x with | None -> find (i + 1) | Some v -> (* By definition of [acases], the following [get] cannot fail. *) Matched (Uint_option.get tag, encoding, v) in find 0 in matching ~tag_size match_case cases let case ~title ?description tag encoding proj inj = let tag = match tag with | Tag t -> if t < 0 then raise (Invalid_argument "Data_encoding.tag: negative tag") else make_tag t | Json_only -> json_only in Case {title; description; encoding; proj; inj; tag} let matched ?(tag_size : [`Uint8 | `Uint16] = `Uint8) tag encoding v = if tag < 0 then raise (Invalid_argument "Data_encoding.matched: negative tag"); valid_tag tag_size tag; Matched (tag, encoding, v) let rec is_nullable : type t. t encoding -> bool = fun e -> match e.encoding with | Null -> true | Empty -> false | Ignore -> true | Constant _ -> false | Bool -> false | Int8 -> false | Uint8 -> false | Int16 -> false | Uint16 -> false | Int31 -> false | Int32 -> false | Int64 -> false | N -> false | Z -> false | RangedInt _ -> false | RangedFloat _ -> false | Float -> false | Bytes _ -> false | String _ -> false | Padded (e, _) -> is_nullable e | String_enum _ -> false | Array _ -> false | List _ -> false | Obj _ -> false | Objs _ -> false | Tup _ -> false | Tups _ -> false | Union {cases; _} -> List.exists (fun (Case {encoding = e; _}) -> is_nullable e) cases | Mu {fix; _} -> is_nullable (fix e) | Conv {encoding = e; _} -> is_nullable e | Describe {encoding = e; _} -> is_nullable e | Splitted {json_encoding; _} -> Json_encoding.is_nullable json_encoding | Dynamic_size {encoding = e; _} -> is_nullable e | Check_size {encoding = e; _} -> is_nullable e | Delayed _ -> true let option ty = if is_nullable ty then invalid_arg "Data_encoding.option: cannot nest nullable encodings"; (* TODO add a special construct `Option` in the GADT *) union ~tag_size:`Uint8 [ case (Tag 1) ty ~title:"Some" (fun x -> x) (fun x -> Some x); case (Tag 0) null ~title:"None" (function None -> Some () | Some _ -> None) (fun () -> None); ] let mu name ?title ?description fix = (* The latest application of [fix] is memoized to avoid recomputing it each time a value encoded by [mu] is processed. [fix] may sometimes be applied to distinct arguments if the encoding is used in different contexts. Hence, we remember the last input of [fix] in the closure, so that we can recompute [fix] if this argument has changed. This partial memoization only takes a bounded amount of memory and is useful because in practice we decode many values before applying [fix] to a new argument. *) let self = ref None in let fix_f = fix in let fix e = match !self with | Some (e0, e') when e == e0 -> e' | _ -> let e' = fix_f e in self := Some (e, e'); e' in (* Attempt to determine kind. Note that this can results in memoisation misses: the [fix] function might be called multiple times. *) try let precursor = make @@ Mu {kind = `Dynamic; name; title; description; fix} in let fixed_precursor = fix precursor in match classify @@ fixed_precursor with | `Fixed _ | `Dynamic -> fixed_precursor | `Variable -> raise Exit with | (Out_of_memory | Stack_overflow) as e -> raise e | Exit | _ (* TODO variability error *) -> let precursor = make @@ Mu {kind = `Variable; name; title; description; fix} in let fixed_precursor = fix precursor in ignore (classify fixed_precursor); fixed_precursor let result ok_enc error_enc = union ~tag_size:`Uint8 [ case (Tag 1) (obj1 (req "ok" ok_enc)) ~title:"Ok" (function Ok x -> Some x | Error _ -> None) (fun x -> Ok x); case (Tag 0) (obj1 (req "error" error_enc)) ~title:"Result" (function Ok _ -> None | Error x -> Some x) (fun x -> Error x); ]
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>