Struct ron::ser::PrettyConfig

#[non_exhaustive]
pub struct PrettyConfig {
    pub depth_limit: usize,
    pub new_line: String,
    pub indentor: String,
    pub separator: String,
    pub struct_names: bool,
    pub separate_tuple_members: bool,
    pub enumerate_arrays: bool,
    pub extensions: Extensions,
    pub compact_arrays: bool,
}

Pretty serializer configuration.

Examples

use ron::ser::PrettyConfig;

let my_config = PrettyConfig::new()
    .depth_limit(4)
    // definitely superior (okay, just joking)
    .indentor("\t".to_owned());

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

depth_limit: usize

Limit the pretty-ness up to the given depth.

new_line: String

New line string

indentor: String

Indentation string

separator: String

Separator string

struct_names: bool

separate_tuple_members: bool

Separate tuple members with indentation

enumerate_arrays: bool

Enumerate array items in comments

extensions: Extensions

Enable extensions. Only configures ‘implicit_some’, ‘unwrap_newtypes’, and ‘unwrap_variant_newtypes’ for now.

compact_arrays: bool

Enable compact arrays

Implementations

impl PrettyConfig

pub fn new() -> Self

Creates a default PrettyConfig.

pub fn depth_limit(self, depth_limit: usize) -> Self

Limits the pretty-formatting based on the number of indentations. I.e., with a depth limit of 5, starting with an element of depth (indentation level) 6, everything will be put into the same line, without pretty formatting.

Default: usize::MAX

pub fn new_line(self, new_line: String) -> Self

Configures the newlines used for serialization.

Default: \r\n on Windows, \n otherwise

pub fn indentor(self, indentor: String) -> Self

Configures the string sequence used for indentation.

Default: 4 spaces

pub fn separator(self, separator: String) -> Self

Configures the string sequence used to separate items inline.

Default: 1 space

pub fn struct_names(self, struct_names: bool) -> Self

Configures whether to emit struct names.

Default: false

pub fn separate_tuple_members(self, separate_tuple_members: bool) -> Self

Configures whether tuples are single- or multi-line. If set to true, tuples will have their fields indented and in new lines. If set to false, tuples will be serialized without any newlines or indentations.

Default: false

pub fn enumerate_arrays(self, enumerate_arrays: bool) -> Self

Configures whether a comment shall be added to every array element, indicating the index.

Default: false

pub fn compact_arrays(self, compact_arrays: bool) -> Self

Configures whether every array should be a single line (true) or a multi line one (false).

When false, ["a","b"] (as well as any array) will serialize to

[
  "a",
  "b",
]

When true, ["a","b"] (as well as any array) will serialize to

["a","b"]

Default: false

pub fn extensions(self, extensions: Extensions) -> Self

Configures extensions

Default: Extensions::empty()

Trait Implementations

impl Clone for PrettyConfig

fn clone(&self) -> PrettyConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrettyConfig

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

Formats the value using the given formatter.

impl Default for PrettyConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PrettyConfigwhere PrettyConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PrettyConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.