package ocaml-protoc-plugin

  1. Overview
  2. Docs
package ocaml-protoc-plugin
Legend:
Library
Module
Module type
Parameter
Class
Class type
module OptimizeMode : sig ... end

Generated classes can be optimized for speed or code size.

type t = {
  1. java_package : string option;
    (*

    Sets the Java package where classes generated from this .proto will be placed. By default, the proto package is used, but this is often inappropriate because proto packages do not normally start with backwards domain names.

    *)
  2. java_outer_classname : string option;
    (*

    Controls the name of the wrapper Java class generated for the .proto file. That class will always contain the .proto file's getDescriptor() method as well as any top-level extensions defined in the .proto file. If java_multiple_files is disabled, then all the other classes from the .proto file will be nested inside the single wrapper outer class.

    *)
  3. optimize_for : OptimizeMode.t;
    (*

    Clients can define custom options in extensions of this message. See the documentation for the "Options" section above.

    *)
  4. java_multiple_files : bool;
    (*

    If enabled, then the Java code generator will generate a separate .java file for each top-level message, enum, and service defined in the .proto file. Thus, these types will *not* be nested inside the wrapper class named by java_outer_classname. However, the wrapper class will still be generated to contain the file's getDescriptor() method as well as any top-level extensions defined in the file.

    *)
  5. go_package : string option;
    (*

    Sets the Go package where structs generated from this .proto will be placed. If omitted, the Go package will be derived from the following:

    • The basename of the package import path, if provided.
    • Otherwise, the package statement in the .proto file, if present.
    • Otherwise, the basename of the .proto file, without extension.
    *)
  6. cc_generic_services : bool;
    (*

    Should generic services be generated in each language? "Generic" services are not specific to any particular RPC system. They are generated by the main code generators in each language (without additional plugins). Generic services were the only kind of service generation supported by early versions of google.protobuf.

    Generic services are now considered deprecated in favor of using plugins that generate code specific to your particular RPC system. Therefore, these default to false. Old code which depends on generic services should explicitly set them to true.

    *)
  7. java_generic_services : bool;
  8. py_generic_services : bool;
  9. java_generate_equals_and_hash : bool option;
    (*

    This option does nothing.

    • alert protobuf Marked as deprecated in the .proto file
    *)
  10. deprecated : bool;
    (*

    Is this file deprecated? Depending on the target platform, this can emit Deprecated annotations for everything in the file, or it will be completely ignored; in the very least, this is a formalization for deprecating files.

    *)
  11. java_string_check_utf8 : bool;
    (*

    If set true, then the Java2 code generator will generate code that throws an exception whenever an attempt is made to assign a non-UTF-8 byte sequence to a string field. Message reflection will do the same. However, an extension field still accepts non-UTF-8 byte sequences. This option has no effect on when used with the lite runtime.

    *)
  12. cc_enable_arenas : bool;
    (*

    Enables the use of arenas for the proto messages in this file. This applies only to generated classes for C++.

    *)
  13. objc_class_prefix : string option;
    (*

    Sets the objective c class prefix which is prepended to all objective c generated classes from this .proto. There is no default.

    *)
  14. csharp_namespace : string option;
    (*

    Namespace for generated classes; defaults to the package.

    *)
  15. swift_prefix : string option;
    (*

    By default Swift generators will take the proto package and CamelCase it replacing '.' with underscore and use that to prefix the types/symbols defined. When this options is provided, they will use this value instead to prefix the types/symbols defined.

    *)
  16. php_class_prefix : string option;
    (*

    Sets the php class prefix which is prepended to all php generated classes from this .proto. Default is empty.

    *)
  17. php_namespace : string option;
    (*

    Use this option to change the namespace of php generated classes. Default is empty. When this option is empty, the package name will be used for determining the namespace.

    *)
  18. php_generic_services : bool;
  19. php_metadata_namespace : string option;
    (*

    Use this option to change the namespace of php generated metadata classes. Default is empty. When this option is empty, the proto file name will be used for determining the namespace.

    *)
  20. ruby_package : string option;
    (*

    Use this option to change the package of ruby generated classes. Default is empty. When this option is not set, the package name will be used for determining the ruby package.

    *)
  21. uninterpreted_option : UninterpretedOption.t list;
    (*

    The parser stores options it doesn't recognize here. See the documentation for the "Options" section above.

    *)
  22. extensions' : Ocaml_protoc_plugin.Extensions.t;
}
val make : ?java_package:string -> ?java_outer_classname:string -> ?optimize_for:OptimizeMode.t -> ?java_multiple_files:bool -> ?go_package:string -> ?cc_generic_services:bool -> ?java_generic_services:bool -> ?py_generic_services:bool -> ?java_generate_equals_and_hash:bool -> ?deprecated:bool -> ?java_string_check_utf8:bool -> ?cc_enable_arenas:bool -> ?objc_class_prefix:string -> ?csharp_namespace:string -> ?swift_prefix:string -> ?php_class_prefix:string -> ?php_namespace:string -> ?php_generic_services:bool -> ?php_metadata_namespace:string -> ?ruby_package:string -> ?uninterpreted_option:UninterpretedOption.t list -> ?extensions':Ocaml_protoc_plugin.Extensions.t -> unit -> t

Helper function to generate a message using default values

Serialize the message to binary format

Deserialize from binary format

Serialize to Json (compatible with Yojson.Basic.t)

Deserialize from Json (compatible with Yojson.Basic.t)

val name : unit -> string

Fully qualified protobuf name of this message