package ocaml-protoc

You can search for identifiers within the package.

in-package search v0.2.0

Pure OCaml compiler for .proto files

Install

Dune Dependency

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

Authors

Maintainers

Sources

ocaml-protoc-3.1.tbz

sha256=4bd16bb119f5c55a9d5e906173d8611cb7664a0c926f108077eb05f1ceb7de03

sha512=01266efcc926dd7042e9eddc874b0c41c65688b36ec3e30756a69e09d6cc57eaa8d4a043015b668a2e61cc45cac7efa51cdbad06757a98a55ff53416af98c44d

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

Module `Ocaml_protoc_compiler_lib.Pb_typing_util`Source

Typed tree utilities

This module provides accessor/creator function to facilitate the manipulation of the type tree.

Sourcemodule Pt = Pb_parsing_parse_tree

Sourcemodule Tt = Pb_typing_type_tree

Accessors for Tt.field type

Sourceval field_name : ('a, 'b) Tt.field -> string

field_name field returns the name field

Sourceval field_number : ('a, 'b) Tt.field -> int

field_number field returns the number of field

Sourceval field_type : ('a, 'b) Tt.field -> 'a Pb_field_type.t

field_type field returns the type of field

Sourceval field_label : ('a, 'b) Tt.field -> 'b

field_label field returns the label of field

Sourceval field_default : ('a, 'b) Tt.field -> Pb_option.constant option

field_default field returns the default value of field

Sourceval field_options : ('a, 'b) Tt.field -> Pb_option.set

Sourceval field_option : ('a, 'b) Tt.field -> string -> Pb_option.value option

field_option field option_name returns the constant associated with option_name. If the fields options does not contain option_name None is returned.

Sourceval type_of_id : 'a Tt.proto_type list -> int -> 'a Tt.proto_type

type_of_id all_types id returns the type associated with the given id, raise Not_found if the type is not in the all_types.

Sourceval string_of_message : int -> Tt.type_scope -> 'a Tt.message -> string

Sourceval message_option : 'a Tt.message -> string -> Pb_option.value option

Sourceval enum_option : Tt.enum -> string -> Pb_option.value option

Accessor for Tt.type

Sourceval type_name_of_type : 'a Tt.proto_type -> string

type_name_of_type t returns the type name (as defined in the message file) of t.

Sourceval type_scope_of_type : 'a Tt.proto_type -> Tt.type_scope

type_scope_of_type t returns the scope of type t.

Sourceval is_empty_message : 'a Tt.proto_type -> bool

is_empty_message t returns true if t is a message type and has no fields defined.

Creator

Sourceval empty_scope : Tt.type_scope

On This Page

Accessors for Tt.field type
Accessor for Tt.type
Creator