Struct prost_reflect::SerializeOptions

pub struct SerializeOptions { /* private fields */ }

Available on crate feature serde only.

Options to control serialization of messages.

Used by DynamicMessage::serialize_with_options().

Implementations

impl SerializeOptions

pub const fn new() -> Self

Creates a new instance of SerializeOptions, with the default options chosen to conform to the standard JSON mapping.

pub const fn stringify_64_bit_integers(self, yes: bool) -> Self

Whether to encode 64-bit integral types as strings.

The spec requires encoding 64-bit integers as strings, to prevent loss of precision in JSON when the value cannot be represented exactly by a double. If this option is disabled, all numbers will be serialized as their corresponding serde types instead.

The default value is true.

pub const fn use_enum_numbers(self, yes: bool) -> Self

Whether to encode enum values as their numeric value.

If true, enum values will be serialized as their integer values. Otherwise, they will be serialized as the string value specified in the proto file.

The default value is false.

pub const fn use_proto_field_name(self, yes: bool) -> Self

Whether to use the proto field name instead of the lowerCamelCase name in JSON field names.

The default value is false.

pub const fn skip_default_fields(self, yes: bool) -> Self

Whether to skip fields which have their default value.

If true, any fields for which has_field returns false will not be serialized. If false, they will be serialized with their default value.

The default value is true.

Trait Implementations

impl Clone for SerializeOptions

fn clone(&self) -> SerializeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SerializeOptions

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

Formats the value using the given formatter.

impl Default for SerializeOptions

fn default() -> Self

Returns the “default value” for a type.