Add newline separators (#777)

jonasbb · Sep 12, 2024 · aede9d5 · aede9d5
2 parents 2a28e46 + b1ee949
commit aede9d5
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 5 deletions.
diff --git a/serde_with/src/formats.rs b/serde_with/src/formats.rs
@@ -138,3 +138,23 @@ impl Separator for ColonSeparator {
         ":"
     }
 }
+
+/// Predefined separator using a single linefeed.
+pub struct UnixLineSeparator;
+
+impl Separator for UnixLineSeparator {
+    #[inline]
+    fn separator() -> &'static str {
+        "\n"
+    }
+}
+
+/// Predefined separator using a DOS/Windows line ending.
+pub struct DosLineSeparator;
+
+impl Separator for DosLineSeparator {
+    #[inline]
+    fn separator() -> &'static str {
+        "\r\n"
+    }
+}
diff --git a/serde_with/tests/serde_as/lib.rs b/serde_with/tests/serde_as/lib.rs
@@ -519,7 +519,7 @@ fn test_bytes_or_string() {
 #[test]
 fn string_with_separator() {
     use serde_with::{
-        formats::{CommaSeparator, SpaceSeparator},
+        formats::{CommaSeparator, DosLineSeparator, SpaceSeparator, UnixLineSeparator},
         StringWithSeparator,
     };
 
@@ -529,26 +529,44 @@ fn string_with_separator() {
         #[serde_as(as = "StringWithSeparator::<SpaceSeparator, String>")]
         tags: Vec<String>,
         #[serde_as(as = "StringWithSeparator::<CommaSeparator, String>")]
-        // more_tags: Vec<String>,
         more_tags: BTreeSet<String>,
+        #[serde_as(as = "StringWithSeparator::<UnixLineSeparator, String>")]
+        lf_tags: BTreeSet<String>,
+        #[serde_as(as = "StringWithSeparator::<DosLineSeparator, String>")]
+        crlf_tags: BTreeSet<String>,
     }
 
     let v: A = serde_json::from_str(
         r##"{
     "tags": "#hello #world",
-    "more_tags": "foo,bar,bar"
+    "more_tags": "foo,bar,bar",
+    "lf_tags": "foo\nbar\nbar",
+    "crlf_tags": "foo\r\nbar\r\nbar"
 }"##,
     )
     .unwrap();
     assert_eq!(vec!["#hello", "#world"], v.tags);
-    assert_eq!(2, v.more_tags.len());
+    assert_eq!(
+        BTreeSet::from(["foo".to_string(), "bar".to_string()]),
+        v.more_tags
+    );
+    assert_eq!(
+        BTreeSet::from(["foo".to_string(), "bar".to_string()]),
+        v.lf_tags
+    );
+    assert_eq!(
+        BTreeSet::from(["foo".to_string(), "bar".to_string()]),
+        v.crlf_tags
+    );
 
     let x = A {
         tags: vec!["1".to_string(), "2".to_string(), "3".to_string()],
         more_tags: BTreeSet::default(),
+        lf_tags: BTreeSet::default(),
+        crlf_tags: BTreeSet::default(),
     };
     assert_eq!(
-        r#"{"tags":"1 2 3","more_tags":""}"#,
+        r#"{"tags":"1 2 3","more_tags":"","lf_tags":"","crlf_tags":""}"#,
         serde_json::to_string(&x).unwrap()
     );
 }