GenerationConfig Options

Every option except new("module_name") is a chained builder method. Boolean flags default to the value shown.

OptionDefaultPurpose
with_conversion(selector)—Generic *_as::<T>() / *_from(&t) per selected field
with_domain_type(selector, path)—One canonical app type per field (implies conversion); Generated impl
with_manual_domain_type(selector, path)—Same signatures, caller supplies TryFromSbe/TryToSbe
with_domain_objects(var_data)offOwned *Domain + encode; Strings → String (bad UTF-8 → InvalidUtf8), Bytes → Vec<u8>
with_display_debug(enable: bool)trueEmit Debug/Display impls on generated types
with_meta_attributes(enable: bool)trueEmit *_ENCODING_OFFSET, *_ID, *_META_ATTRIBUTE etc.
with_dispatch(enable: bool)trueEmit AnyMessage/FrameCursor/MessageVisitor dispatch
with_bool_domain_type(enable: bool)falseAuto-register bool converters for every boolean enum (name, semanticType, or {0,1} value pair)
with_null_as_option(selector)—NullVal → None for matching enum fields; getter returns Option<Enum>
with_all_enums_as_option()falseAll enums → Option<Enum>; blanket form of with_null_as_option
profile(GenerationProfile)FullPreset: Full (default conveniences) or Lean (off: Display/Debug, meta attrs, dispatch; domains stay off unless re-enabled). Individual with_* overrides still apply after profile.
with_deprecated_attrs(enable: bool)false#[deprecated] on schema-deprecated items
with_error_from_impls(path)—Deprecated since 0.1.19 (removed in 1.0). Lossy From<EncodeError/DecodeError> via format! + From<String>. Prefer a field-preserving From impl (below).
with_shared_module(name)—Multi-schema shared types module
with_external_sbe_rt(path)—Share one sbe_rt runtime module instead of inlining
with_keyword_append_token(token)"_"Schema type → Rust type_
with_hook(fn)—Register a code-generation hook (serde, custom traits, …)

Turn off with_display_debug, with_meta_attributes, and with_dispatch to reduce generated-code size (~6,100 lines/message with all on). Text fields stay bytes unless the schema declares a character encoding (then strict UTF-8/ASCII helpers apply).

Migrating off with_error_from_impls

with_error_from_impls formats the generated error through Display and From<String>, so fields such as needed and available are lost. Implement From yourself on the generated sbe_rt types (removed in 1.0):

#![allow(unused)]
fn main() {
enum AppError {
    Encode(sbe_rt::EncodeError),
    Decode(sbe_rt::DecodeError),
}

impl From<sbe_rt::EncodeError> for AppError {
    fn from(error: sbe_rt::EncodeError) -> Self {
        match error {
            sbe_rt::EncodeError::BufferTooShort {
                field,
                needed,
                available,
            } => {
                let _ = (field, needed, available);
                Self::Encode(error)
            }
            other => Self::Encode(other),
        }
    }
}

impl From<sbe_rt::DecodeError> for AppError {
    fn from(error: sbe_rt::DecodeError) -> Self {
        Self::Decode(error)
    }
}
}