Struct CodegenOptions 

pub struct CodegenOptions {

    pub generate_docs: bool,
    pub generate_default: bool,
    pub generate_deprecated: bool,
    pub btree_map: bool,
    pub use_btree_map: bool,
    pub package_namespacing: bool,
    pub type_attributes: BTreeMap<String, Vec<String>>,
    pub field_attributes: BTreeMap<String, Vec<String>>,
    pub emit_oxi_message_impl: bool,
    pub format_output: bool,
    pub emit_services: bool,
    pub emit_json: bool,
    pub emit_builder: bool,
    pub emit_text_format: bool,
}

Options controlling code generation from a FileDescriptorSet.

Fields

generate_docs: bool

Generate doc comments from proto source info (default: true)

generate_default: bool

Generate Default impls for enums (default: true)

generate_deprecated: bool

Use #[deprecated] for deprecated fields/messages/enums (default: true)

btree_map: bool

Use BTreeMap for proto map fields instead of HashMap (default: false)

use_btree_map: bool

Alias for btree_map kept for backward compat with existing tests

package_namespacing: bool

Emit pub mod hierarchy matching the proto package structure (default: true). When false, all types are emitted flat (no module nesting).

type_attributes: BTreeMap<String, Vec<String>>

Per-type custom attributes. Key: fully-qualified proto type name. Value: list of attribute strings (e.g., ["#[derive(serde::Serialize)]"]).

field_attributes: BTreeMap<String, Vec<String>>

Per-field custom attributes. Key: “TypeName.field_name”. Value: list of attribute strings.

emit_oxi_message_impl: bool

Emit impl OxiMessage for T + impl OxiName for T blocks (default: false). Requires oxiproto-core as a dependency of the crate using generated code.

format_output: bool

Use prettyplease to format generated code (requires format feature).

emit_services: bool

Emit pub trait … service definitions (default: true). Set to false to suppress service-trait emission (e.g. --grpc=false in the CLI).

emit_json: bool

Emit self-contained to_json/from_json methods on generated types (canonical Protobuf-JSON mapping). Requires serde_json and base64 in the consumer crate. Default: false.

emit_builder: bool

Emit a FooBuilder struct with fluent setters for each message (default: false).

emit_text_format: bool

Emit a to_text_format() -> String method on each generated message struct (default: false).

Implementations

impl CodegenOptions

pub fn new() -> Self

Create options with sensible proto3 defaults.

pub fn use_btree_map_effective(&self) -> bool

Returns true if BTreeMap should be used for map fields.

Trait Implementations

impl Clone for CodegenOptions

fn clone(&self) -> CodegenOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodegenOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CodegenOptions

fn default() -> Self

Returns the “default value” for a type.