Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions crates/detrim/src/string.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,30 @@ pub fn string<'de, D: Deserializer<'de>>(de: D) -> Result<String, D::Error> {
}

/// Trims an optional string during deserialization.
///
/// A null value becomes `None`. A string that is empty after trimming becomes
/// `Some("")`. Use [`crate::option_string_non_empty`] to return `None` for empty strings.
///
/// Add `#[serde(default)]` to accept a missing field as `None`.
///
/// # Examples
///
/// ```
/// #[derive(serde::Deserialize)]
/// struct Form {
/// #[serde(default, deserialize_with = "detrim::option_string")]
/// name: Option<String>,
/// }
///
/// let form: Form = serde_json::from_str(r#"{}"#).unwrap();
/// assert_eq!(form.name, None);
///
/// let form: Form = serde_json::from_str(r#"{"name": null}"#).unwrap();
/// assert_eq!(form.name, None);
///
/// let form: Form = serde_json::from_str(r#"{"name": " "}"#).unwrap();
/// assert_eq!(form.name.as_deref(), Some(""));
/// ```
pub fn option_string<'de, D: Deserializer<'de>>(de: D) -> Result<Option<String>, D::Error> {
let val = Option::<String>::deserialize(de)?;
Ok(val.map(|val| val.trim().to_owned()))
Expand Down
Loading