Source file any.ml

(********************************************************)
(*           AUTOGENERATED FILE - DO NOT EDIT!          *)
(********************************************************)
(* Generated by: ocaml-protoc-plugin                    *)
(* https://github.com/andersfugmann/ocaml-protoc-plugin *)
(********************************************************)
(*
  Source: google/protobuf/any.proto
  Syntax: proto3
  Parameters:
    debug=false
    annot=''
    opens=[]
    int64_as_int=true
    int32_as_int=true
    fixed_as_int=false
    singleton_record=false
    prefix_output_with_package=false
*)
[@@@ocaml.alert "-protobuf"] (* Disable deprecation warnings for protobuf*)
(**/**)
module Runtime' = Ocaml_protoc_plugin [@@warning "-33"]
module Imported'modules = struct
end
(**/**)
module rec Google : sig
  module rec Protobuf : sig

    (**
{%html:
<p><code>Any</code> contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.</p>
<p>Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.</p>
<p>Example 1: Pack and unpack a message in C++.</p>
<pre><code> Foo foo = ...;
 Any any;
 any.PackFrom(foo);
 ...
 if (any.UnpackTo(&amp;foo)) {
   ...
 }
</code></pre>
<p>Example 2: Pack and unpack a message in Java.</p>
<pre><code> Foo foo = ...;
 Any any = Any.pack(foo);
 ...
 if (any.is(Foo.class)) {
   foo = any.unpack(Foo.class);
 }
</code></pre>
<p>or ...</p>
<pre><code> if (any.isSameTypeAs(Foo.getDefaultInstance())) {
   foo = any.unpack(Foo.getDefaultInstance());
 }
</code></pre>
<p>Example 3: Pack and unpack a message in Python.</p>
<pre><code> foo = Foo(...)
 any = Any()
 any.Pack(foo)
 ...
 if any.Is(Foo.DESCRIPTOR):
   any.Unpack(foo)
   ...
</code></pre>
<p>Example 4: Pack and unpack a message in Go</p>
<pre><code>  foo := &amp;pb.Foo{...}
  any, err := anypb.New(foo)
  if err != nil {
    ...
  }
  ...
  foo := &amp;pb.Foo{}
  if err := any.UnmarshalTo(foo); err != nil {
    ...
  }
</code></pre>
<p>The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example &quot;foo.bar.com/x/y.z&quot; will yield type
name &quot;y.z&quot;.</p>
<h1 id="json">JSON</h1>
<p>The JSON representation of an <code>Any</code> value uses the regular
representation of the deserialized, embedded message, with an
additional field <code>@type</code> which contains the type URL. Example:</p>
<pre><code> package google.profile;
 message Person {
   string first_name = 1;
   string last_name = 2;
 }

 {
   &quot;@type&quot;: &quot;type.googleapis.com/google.profile.Person&quot;,
   &quot;firstName&quot;: &lt;string&gt;,
   &quot;lastName&quot;: &lt;string&gt;
 }
</code></pre>
<p>If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
<code>value</code> which holds the custom JSON in addition to the <code>@type</code>
field. Example (for message <em>google.protobuf.Duration</em>):</p>
<pre><code> {
   &quot;@type&quot;: &quot;type.googleapis.com/google.protobuf.Duration&quot;,
   &quot;value&quot;: &quot;1.212s&quot;
 }
</code></pre>
%}
    *)
    module rec Any : sig
      type t = {
        type_url:string;
        (**
{%html:
<p>A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one &quot;/&quot; character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
<code>path/google.protobuf.Duration</code>). The name should be in a canonical form
(e.g., leading &quot;.&quot; is not accepted).</p>
<p>In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme <code>http</code>, <code>https</code>, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:</p>
<ul>
<li>
<p>If no scheme is provided, <code>https</code> is assumed.</p>
</li>
<li>
<p>An HTTP GET on the URL must yield a <em>google.protobuf.Type</em></p>
<p>value in binary format, or produce an error.</p>
</li>
<li>
<p>Applications are allowed to cache lookup results based on the</p>
<p>URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)</p>
</li>
</ul>
<p>Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com. As of May 2023, there are no widely used type server
implementations and no plans to implement one.</p>
<p>Schemes other than <code>http</code>, <code>https</code> (or the empty scheme) might be
used with implementation specific semantics.</p>
%}
        *)

        value:bytes;
        (**
{%html:
<p>Must be a valid serialized protocol buffer of the above specified type.</p>
%}
        *)

      }
      val make: ?type_url:string -> ?value:bytes -> unit -> t
      (** Helper function to generate a message using default values *)

      val to_proto: t -> Runtime'.Writer.t
      (** Serialize the message to binary format *)

      val from_proto: Runtime'.Reader.t -> (t, [> Runtime'.Result.error]) result
      (** Deserialize from binary format *)

      val to_json: Runtime'.Json_options.t -> t -> Runtime'.Json.t
      (** Serialize to Json (compatible with Yojson.Basic.t) *)

      val from_json: Runtime'.Json.t -> (t, [> Runtime'.Result.error]) result
      (** Deserialize from Json (compatible with Yojson.Basic.t) *)

      val name: unit -> string
      (** Fully qualified protobuf name of this message *)

      (**/**)
      type make_t = ?type_url:string -> ?value:bytes -> unit -> t
      val merge: t -> t -> t
      val to_proto': Runtime'.Writer.t -> t -> unit
      val from_proto_exn: Runtime'.Reader.t -> t
      val from_json_exn: Runtime'.Json.t -> t
      (**/**)
    end

  end
end = struct
  module rec Protobuf : sig

    (**
{%html:
<p><code>Any</code> contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.</p>
<p>Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.</p>
<p>Example 1: Pack and unpack a message in C++.</p>
<pre><code> Foo foo = ...;
 Any any;
 any.PackFrom(foo);
 ...
 if (any.UnpackTo(&amp;foo)) {
   ...
 }
</code></pre>
<p>Example 2: Pack and unpack a message in Java.</p>
<pre><code> Foo foo = ...;
 Any any = Any.pack(foo);
 ...
 if (any.is(Foo.class)) {
   foo = any.unpack(Foo.class);
 }
</code></pre>
<p>or ...</p>
<pre><code> if (any.isSameTypeAs(Foo.getDefaultInstance())) {
   foo = any.unpack(Foo.getDefaultInstance());
 }
</code></pre>
<p>Example 3: Pack and unpack a message in Python.</p>
<pre><code> foo = Foo(...)
 any = Any()
 any.Pack(foo)
 ...
 if any.Is(Foo.DESCRIPTOR):
   any.Unpack(foo)
   ...
</code></pre>
<p>Example 4: Pack and unpack a message in Go</p>
<pre><code>  foo := &amp;pb.Foo{...}
  any, err := anypb.New(foo)
  if err != nil {
    ...
  }
  ...
  foo := &amp;pb.Foo{}
  if err := any.UnmarshalTo(foo); err != nil {
    ...
  }
</code></pre>
<p>The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example &quot;foo.bar.com/x/y.z&quot; will yield type
name &quot;y.z&quot;.</p>
<h1 id="json">JSON</h1>
<p>The JSON representation of an <code>Any</code> value uses the regular
representation of the deserialized, embedded message, with an
additional field <code>@type</code> which contains the type URL. Example:</p>
<pre><code> package google.profile;
 message Person {
   string first_name = 1;
   string last_name = 2;
 }

 {
   &quot;@type&quot;: &quot;type.googleapis.com/google.profile.Person&quot;,
   &quot;firstName&quot;: &lt;string&gt;,
   &quot;lastName&quot;: &lt;string&gt;
 }
</code></pre>
<p>If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
<code>value</code> which holds the custom JSON in addition to the <code>@type</code>
field. Example (for message <em>google.protobuf.Duration</em>):</p>
<pre><code> {
   &quot;@type&quot;: &quot;type.googleapis.com/google.protobuf.Duration&quot;,
   &quot;value&quot;: &quot;1.212s&quot;
 }
</code></pre>
%}
    *)
    module rec Any : sig
      type t = {
        type_url:string;
        (**
{%html:
<p>A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one &quot;/&quot; character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
<code>path/google.protobuf.Duration</code>). The name should be in a canonical form
(e.g., leading &quot;.&quot; is not accepted).</p>
<p>In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme <code>http</code>, <code>https</code>, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:</p>
<ul>
<li>
<p>If no scheme is provided, <code>https</code> is assumed.</p>
</li>
<li>
<p>An HTTP GET on the URL must yield a <em>google.protobuf.Type</em></p>
<p>value in binary format, or produce an error.</p>
</li>
<li>
<p>Applications are allowed to cache lookup results based on the</p>
<p>URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)</p>
</li>
</ul>
<p>Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com. As of May 2023, there are no widely used type server
implementations and no plans to implement one.</p>
<p>Schemes other than <code>http</code>, <code>https</code> (or the empty scheme) might be
used with implementation specific semantics.</p>
%}
        *)

        value:bytes;
        (**
{%html:
<p>Must be a valid serialized protocol buffer of the above specified type.</p>
%}
        *)

      }
      val make: ?type_url:string -> ?value:bytes -> unit -> t
      (** Helper function to generate a message using default values *)

      val to_proto: t -> Runtime'.Writer.t
      (** Serialize the message to binary format *)

      val from_proto: Runtime'.Reader.t -> (t, [> Runtime'.Result.error]) result
      (** Deserialize from binary format *)

      val to_json: Runtime'.Json_options.t -> t -> Runtime'.Json.t
      (** Serialize to Json (compatible with Yojson.Basic.t) *)

      val from_json: Runtime'.Json.t -> (t, [> Runtime'.Result.error]) result
      (** Deserialize from Json (compatible with Yojson.Basic.t) *)

      val name: unit -> string
      (** Fully qualified protobuf name of this message *)

      (**/**)
      type make_t = ?type_url:string -> ?value:bytes -> unit -> t
      val merge: t -> t -> t
      val to_proto': Runtime'.Writer.t -> t -> unit
      val from_proto_exn: Runtime'.Reader.t -> t
      val from_json_exn: Runtime'.Json.t -> t
      (**/**)
    end

  end = struct
    module rec Any : sig
      type t = {
        type_url:string;
        (**
{%html:
<p>A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one &quot;/&quot; character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
<code>path/google.protobuf.Duration</code>). The name should be in a canonical form
(e.g., leading &quot;.&quot; is not accepted).</p>
<p>In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme <code>http</code>, <code>https</code>, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:</p>
<ul>
<li>
<p>If no scheme is provided, <code>https</code> is assumed.</p>
</li>
<li>
<p>An HTTP GET on the URL must yield a <em>google.protobuf.Type</em></p>
<p>value in binary format, or produce an error.</p>
</li>
<li>
<p>Applications are allowed to cache lookup results based on the</p>
<p>URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)</p>
</li>
</ul>
<p>Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com. As of May 2023, there are no widely used type server
implementations and no plans to implement one.</p>
<p>Schemes other than <code>http</code>, <code>https</code> (or the empty scheme) might be
used with implementation specific semantics.</p>
%}
        *)

        value:bytes;
        (**
{%html:
<p>Must be a valid serialized protocol buffer of the above specified type.</p>
%}
        *)

      }
      val make: ?type_url:string -> ?value:bytes -> unit -> t
      (** Helper function to generate a message using default values *)

      val to_proto: t -> Runtime'.Writer.t
      (** Serialize the message to binary format *)

      val from_proto: Runtime'.Reader.t -> (t, [> Runtime'.Result.error]) result
      (** Deserialize from binary format *)

      val to_json: Runtime'.Json_options.t -> t -> Runtime'.Json.t
      (** Serialize to Json (compatible with Yojson.Basic.t) *)

      val from_json: Runtime'.Json.t -> (t, [> Runtime'.Result.error]) result
      (** Deserialize from Json (compatible with Yojson.Basic.t) *)

      val name: unit -> string
      (** Fully qualified protobuf name of this message *)

      (**/**)
      type make_t = ?type_url:string -> ?value:bytes -> unit -> t
      val merge: t -> t -> t
      val to_proto': Runtime'.Writer.t -> t -> unit
      val from_proto_exn: Runtime'.Reader.t -> t
      val from_json_exn: Runtime'.Json.t -> t
      (**/**)
    end = struct
      module This'_ = Any
      let name () = ".google.protobuf.Any"
      type t = {
        type_url:string;
        value:bytes;
      }
      type make_t = ?type_url:string -> ?value:bytes -> unit -> t
      let make ?(type_url = {||}) ?(value = (Bytes.of_string {||})) () = { type_url; value }
      let merge =
      let merge_type_url = Runtime'.Merge.merge Runtime'.Spec.( basic ((1, "type_url", "typeUrl"), string, ({||})) ) in
      let merge_value = Runtime'.Merge.merge Runtime'.Spec.( basic ((2, "value", "value"), bytes, ((Bytes.of_string {||}))) ) in
      fun t1 t2 -> {
      	type_url = (merge_type_url t1.type_url t2.type_url);
      	value = (merge_value t1.value t2.value);
       }
      let spec () = Runtime'.Spec.( basic ((1, "type_url", "typeUrl"), string, ({||})) ^:: basic ((2, "value", "value"), bytes, ((Bytes.of_string {||}))) ^:: nil )
      let to_proto' =
        let serialize = Runtime'.apply_lazy (fun () -> Runtime'.Serialize.serialize (spec ())) in
        fun writer { type_url; value } -> serialize writer type_url value

      let to_proto t = let writer = Runtime'.Writer.init () in to_proto' writer t; writer
      let from_proto_exn =
        let constructor type_url value = { type_url; value } in
        Runtime'.apply_lazy (fun () -> Runtime'.Deserialize.deserialize (spec ()) constructor)
      let from_proto writer = Runtime'.Result.catch (fun () -> from_proto_exn writer)
      let to_json options =
        let serialize = Runtime'.Serialize_json.serialize ~message_name:(name ()) (spec ()) options in
        fun { type_url; value } -> serialize type_url value
      let from_json_exn =
        let constructor type_url value = { type_url; value } in
        Runtime'.apply_lazy (fun () -> Runtime'.Deserialize_json.deserialize ~message_name:(name ()) (spec ()) constructor)
      let from_json json = Runtime'.Result.catch (fun () -> from_json_exn json)
    end

  end
end