Struct ForyBuilder

Source

pub struct ForyBuilder { /* private fields */ }

Expand description

Builder for configuring a Fory instance before first use.

ForyBuilder owns the configuration phase. Call build to create the instance, then use Fory for registration and serialization operations.

use fory_core::Fory;

let fory = Fory::builder()
    .compress_string(true)
    .max_dyn_depth(10)
    .build();

Implementations§

Source §

impl ForyBuilder

Source

pub fn compatible(self, compatible: bool) -> ForyBuilder

Sets the serialization compatible mode for this Fory builder.

§Arguments

compatible - The serialization compatible mode to use. Options are:
- false: Every reader and writer must use the same schema. Use only for smaller, faster same-schema payloads.
- true: Supports schema evolution and type metadata sharing for better cross-version compatibility.

§Returns

Returns self for method chaining.

§Note

Setting the compatible mode also automatically configures the share_meta flag:

false → share_meta = false
true → share_meta = true

§Examples

use fory_core::Fory;

// Same-schema optimization.
let fory = Fory::builder().compatible(false).build();

Source

pub fn xlang(self, xlang: bool) -> ForyBuilder

Enables or disables xlang mode.

§Arguments

xlang - If true, uses the xlang wire format compatible with other Fory implementations (Java, Python, C++, etc.). If false, uses Rust native mode.

§Returns

Returns self for method chaining.

§Default

The default value is true.

§Examples

use fory_core::Fory;

// Xlang mode, the default cross-language wire format
let fory = Fory::builder().xlang(true).build();

// Native mode for Rust-only traffic
let fory = Fory::builder().xlang(false).build();

Source

pub fn compress_string(self, compress_string: bool) -> ForyBuilder

Enables or disables meta string compression.

§Arguments

compress_string - If true, enables meta string compression to reduce serialized payload size by deduplicating and encoding frequently used strings (such as type names and field names). If false, strings are serialized without compression.

§Returns

Returns self for method chaining.

§Default

The default value is false.

§Trade-offs

Enabled: Smaller payload size, slightly higher CPU overhead
Disabled: Larger payload size, faster serialization/deserialization

§Examples

use fory_core::Fory;

let fory = Fory::builder().compress_string(true).build();

Source

pub fn check_string_read(self, check_string_read: bool) -> ForyBuilder

Enables or disables checked UTF-8 string reads.

Checked reads validate UTF-8 payload bytes before constructing Rust String values. Disabling this keeps the faster unchecked construction path and must only be used when serialized bytes are trusted to contain valid UTF-8 strings.

§Default

The default value is true.

Source

pub fn check_struct_version(self, check_struct_version: bool) -> ForyBuilder

Enables or disables schema hash checking for same-schema payloads.

§Arguments

check_struct_version - If true, enables schema hash checking for same-schema serialization and deserialization. When enabled, a version hash computed from field types is written/read to detect schema mismatches. If false, no version checking is performed.

§Returns

Returns self for method chaining.

§Default

The default value is false.

§Note

This feature is only effective when compatible mode is false. In compatible mode, schema evolution is supported and version checking is not needed.

§Examples

use fory_core::Fory;

let fory = Fory::builder()
    .compatible(false)
    .check_struct_version(true)
    .build();

Source

pub fn track_ref(self, track_ref: bool) -> ForyBuilder

Enables or disables reference tracking for shared and circular references.

§Arguments

track_ref - If true, enables reference tracking which allows preserving shared object references and circular references during serialization/deserialization.

§Returns

Returns self for method chaining.

§Default

The default value is false.

§Examples

use fory_core::Fory;

let fory = Fory::builder().track_ref(true).build();

Source

pub fn max_dyn_depth(self, max_dyn_depth: u32) -> ForyBuilder

Sets the maximum depth for nested dynamic object serialization.

§Arguments

max_dyn_depth - The maximum nesting depth allowed for dynamically-typed objects (e.g., trait objects, boxed types). This prevents stack overflow from deeply nested structures in dynamic serialization scenarios.

§Returns

Returns self for method chaining.

§Default

The default value is 5.

§Behavior

When the depth limit is exceeded during deserialization, an error is returned to prevent potential stack overflow or infinite recursion.

§Examples

use fory_core::Fory;

// Allow deeper nesting for complex object graphs
let fory = Fory::builder().max_dyn_depth(10).build();

// Restrict nesting for safer deserialization
let fory = Fory::builder().max_dyn_depth(3).build();

Source