package ocaml-protoc

  1. Overview
  2. Docs
Pure OCaml compiler for .proto files

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (20)

Authors

  1. M
    Maxime Ransan <maxime.ransan@gmail.com>
  2. S
    Simon Cruanes

Maintainers

  1. M
    Maxime Ransan <maxime.ransan@gmail.com>
  2. S
    Simon Cruanes

Sources

ocaml-protoc-3.0.1.tbz
sha256=33904442e655b259e18386be2ccc335bfaf69e5ecaf02085b6aa327f5c82c365
sha512=d39b027d6b96f14c08789095990abbdad918ae54eba4ab094bef51931ea6f60c89c8e33cd35c0263c7d54e684deeb53c3272985cecb85d83bf546f3a1cd58af0

doc/ocaml-protoc.compiler-lib/Ocaml_protoc_compiler_lib/Pb_parsing_parse_tree/index.html

Module Ocaml_protoc_compiler_lib.Pb_parsing_parse_treeSource

Protobuf parse tree

Sourcetype message_field_label = [
  1. | `Optional
  2. | `Required
  3. | `Repeated
  4. | `Nolabel
]

A field property defining its occurence

Sourcetype oneof_field_label = unit

Oneof field fields label

Oneof fields have no label, they are simply choices for the oneof fiel they belong to.

Sourcetype 'a field = {
  1. field_name : string;
  2. field_number : int;
  3. field_label : 'a;
  4. field_type : Pb_field_type.unresolved_t;
  5. field_options : Pb_option.set;
}

message field.

Note this field is parametrized with the label type so that it can be used both by normal field and one of field since the only difference between the 2 is the label.

Sourcetype message_field = message_field_label field
Sourcetype oneof_field = oneof_field_label field
Sourcetype map_field = {
  1. map_name : string;
  2. map_number : int;
  3. map_key_type : Pb_field_type.map_key_type;
  4. map_value_type : Pb_field_type.unresolved_t;
  5. map_options : Pb_option.set;
}
Sourcetype oneof_body_content =
  1. | Oneof_field of oneof_field
  2. | Oneof_option of Pb_option.t
Sourcetype oneof = {
  1. oneof_name : string;
  2. oneof_body : oneof_body_content list;
}

oneof entity

Sourcetype enum_value = {
  1. enum_value_name : string;
  2. enum_value_int : int;
}
Sourcetype enum_body_content =
  1. | Enum_value of enum_value
  2. | Enum_option of Pb_option.t
Sourcetype enum = {
  1. enum_id : int;
  2. enum_name : string;
  3. enum_body : enum_body_content list;
}
Sourcetype extension_range_to =
  1. | To_max
  2. | To_number of int
Sourcetype extension_range_from = int
Sourcetype extension_range =
  1. | Extension_single_number of int
  2. | Extension_range of extension_range_from * extension_range_to
Sourcetype message_body_content =
  1. | Message_field of message_field
  2. | Message_map_field of map_field
  3. | Message_oneof_field of oneof
  4. | Message_sub of message
  5. | Message_enum of enum
  6. | Message_extension of extension_range list
  7. | Message_reserved of extension_range list
  8. | Message_option of Pb_option.t

Body content defines all the possible consituant of a message.

Sourceand message = {
  1. id : int;
  2. message_name : string;
  3. message_body : message_body_content list;
}

Message entity.

Note the ID is simply for uniquely (and easily) identifying a type. It is expected to be generated by a parser. The later compilation functions expects this id to be unique.

Sourcetype rpc = {
  1. rpc_name : string;
  2. rpc_options : Pb_option.set;
  3. rpc_req_stream : bool;
  4. rpc_req : Pb_field_type.unresolved_t;
  5. rpc_res_stream : bool;
  6. rpc_res : Pb_field_type.unresolved_t;
}
Sourcetype service_body_content =
  1. | Service_rpc of rpc
  2. | Service_option of Pb_option.t
Sourcetype service = {
  1. service_name : string;
  2. service_body : service_body_content list;
}
Sourcetype extend = {
  1. id : int;
  2. extend_name : string;
  3. extend_body : message_field list;
}
Sourcetype import = {
  1. file_name : string;
  2. public : bool;
}
Sourcetype proto = {
  1. proto_file_name : string option;
  2. syntax : string option;
  3. imports : import list;
  4. file_options : Pb_option.set;
  5. package : string option;
  6. messages : message list;
  7. services : service list;
  8. enums : enum list;
  9. extends : extend list;
}

Definition of a protobuffer message file.

Sourceval pp_message_field_label : Format.formatter -> [< `Nolabel | `Optional | `Repeated | `Required ] -> unit
Sourceval pp_oneof_field_label : 'a -> unit -> unit
Sourceval pp_field : (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a field -> unit
Sourceval pp_message_field : Format.formatter -> [< `Nolabel | `Optional | `Repeated | `Required ] field -> unit
Sourceval pp_oneof_field : Format.formatter -> unit field -> unit
Sourceval pp_map_field : Format.formatter -> map_field -> unit
Sourceval pp_oneof_body_content : Format.formatter -> oneof_body_content -> unit
Sourceval pp_oneof : Format.formatter -> oneof -> unit
Sourceval pp_enum_value : Format.formatter -> enum_value -> unit
Sourceval pp_enum_body_content : Format.formatter -> enum_body_content -> unit
Sourceval pp_enum : Format.formatter -> enum -> unit
Sourceval pp_extension_range_to : Format.formatter -> extension_range_to -> unit
Sourceval pp_extension_range_from : Format.formatter -> int -> unit
Sourceval pp_extension_range : Format.formatter -> extension_range -> unit
Sourceval pp_message_body_content : Format.formatter -> message_body_content -> unit
Sourceval pp_message : Format.formatter -> message -> unit
Sourceval pp_rpc : Format.formatter -> rpc -> unit
Sourceval pp_service_body_content : Format.formatter -> service_body_content -> unit
Sourceval pp_service : Format.formatter -> service -> unit
Sourceval pp_extend : Format.formatter -> extend -> unit
Sourceval pp_import : Format.formatter -> import -> unit
Sourceval pp_proto : Format.formatter -> proto -> unit
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