Struct SortAlphabetically 

pub struct SortAlphabetically<T: Serialize>(pub T);

This is used to serialize any value implementing Serialize alphabetically.

The reason for this is to maintain consistency in the generated JSON string, which is useful for diffing. The default serializer keeps the order of the fields as they are defined in the struct, which will not be consistent when there are extra fields.

Example

use std::collections::BTreeMap;

use serde::Serialize;

use ruff_notebook::SortAlphabetically;

#[derive(Serialize)]
struct MyStruct {
   a: String,
   #[serde(flatten)]
   extra: BTreeMap<String, String>,
   b: String,
}

let my_struct = MyStruct {
    a: "a".to_string(),
    extra: BTreeMap::from([
        ("d".to_string(), "d".to_string()),
        ("c".to_string(), "c".to_string()),
    ]),
    b: "b".to_string(),
};

let serialized = serde_json::to_string_pretty(&SortAlphabetically(&my_struct)).unwrap();
assert_eq!(
    serialized,
r#"{
  "a": "a",
  "b": "b",
  "c": "c",
  "d": "d"
}"#
);

Tuple Fields

0: T

Trait Implementations

impl<T: Serialize> Serialize for SortAlphabetically<T>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.