use std::{
borrow::Cow,
ffi::OsStr,
ops::Deref,
path::{Path, PathBuf},
sync::Arc,
};
use schemars::JsonSchema;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[cfg(feature = "tracing")]
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub struct SkipListener;
#[cfg(feature = "tracing")]
impl serde_with::InspectError for SkipListener {
fn inspect_error(error: impl serde::de::Error) {
tracing::warn!(
%error,
"skipped malformed list entry during deserialization",
);
}
}
#[cfg(not(feature = "tracing"))]
pub type SkipListener = ();
#[cfg(test)]
mod skip_listener_tests {
use std::cell::Cell;
use serde::{Deserialize, Serialize};
use serde_json::json;
use serde_with::{DefaultOnError, VecSkipError, serde_as};
thread_local! {
static SKIP_COUNT: Cell<u32> = const { Cell::new(0) };
}
struct CountingListener;
impl serde_with::InspectError for CountingListener {
fn inspect_error(_error: impl serde::de::Error) {
SKIP_COUNT.with(|c| c.set(c.get() + 1));
}
}
#[serde_as]
#[derive(Serialize, Deserialize, Debug, PartialEq)]
struct Wrapper {
#[serde_as(deserialize_as = "VecSkipError<_, CountingListener>")]
values: Vec<u32>,
}
#[test]
fn inspector_runs_for_each_skipped_entry() {
SKIP_COUNT.with(|c| c.set(0));
let input = json!({"values": [1, "oops", 2, {}, 3]});
let wrapper: Wrapper = serde_json::from_value(input).unwrap();
assert_eq!(wrapper.values, vec![1, 2, 3]);
assert_eq!(SKIP_COUNT.with(Cell::get), 2);
}
#[serde_as]
#[derive(Deserialize, Debug, PartialEq)]
struct ResilientVec {
#[serde_as(deserialize_as = "DefaultOnError<VecSkipError<_, CountingListener>>")]
#[serde(default)]
values: Vec<u32>,
}
#[test]
fn resilient_vec_tolerates_missing_null_and_wrong_type() {
let r: ResilientVec = serde_json::from_value(json!({})).unwrap();
assert_eq!(r.values, Vec::<u32>::new());
let r: ResilientVec = serde_json::from_value(json!({"values": null})).unwrap();
assert_eq!(r.values, Vec::<u32>::new());
let r: ResilientVec = serde_json::from_value(json!({"values": "oops"})).unwrap();
assert_eq!(r.values, Vec::<u32>::new());
let r: ResilientVec = serde_json::from_value(json!({"values": {"k": 1}})).unwrap();
assert_eq!(r.values, Vec::<u32>::new());
SKIP_COUNT.with(|c| c.set(0));
let r: ResilientVec =
serde_json::from_value(json!({"values": [1, "oops", 2, {}, 3]})).unwrap();
assert_eq!(r.values, vec![1, 2, 3]);
assert_eq!(SKIP_COUNT.with(Cell::get), 2);
}
#[test]
fn resilient_vec_does_not_invoke_inspector_on_outer_failure() {
SKIP_COUNT.with(|c| c.set(0));
let _r: ResilientVec = serde_json::from_value(json!({"values": null})).unwrap();
let _r: ResilientVec = serde_json::from_value(json!({"values": "oops"})).unwrap();
let _r: ResilientVec = serde_json::from_value(json!({"values": {}})).unwrap();
assert_eq!(SKIP_COUNT.with(Cell::get), 0);
}
#[serde_as]
#[derive(Deserialize, Debug, PartialEq)]
struct ResilientOptionVec {
#[serde_as(deserialize_as = "DefaultOnError<Option<VecSkipError<_, CountingListener>>>")]
#[serde(default)]
values: Option<Vec<u32>>,
}
#[test]
fn resilient_option_vec_tolerates_missing_null_and_wrong_type() {
let r: ResilientOptionVec = serde_json::from_value(json!({})).unwrap();
assert_eq!(r.values, None);
let r: ResilientOptionVec = serde_json::from_value(json!({"values": null})).unwrap();
assert_eq!(r.values, None);
let r: ResilientOptionVec = serde_json::from_value(json!({"values": []})).unwrap();
assert_eq!(r.values, Some(Vec::<u32>::new()));
let r: ResilientOptionVec = serde_json::from_value(json!({"values": [1, 2, 3]})).unwrap();
assert_eq!(r.values, Some(vec![1, 2, 3]));
let r: ResilientOptionVec = serde_json::from_value(json!({"values": "oops"})).unwrap();
assert_eq!(r.values, None);
let r: ResilientOptionVec = serde_json::from_value(json!({"values": {"k": 1}})).unwrap();
assert_eq!(r.values, None);
SKIP_COUNT.with(|c| c.set(0));
let r: ResilientOptionVec =
serde_json::from_value(json!({"values": [1, "oops", 2, {}, 3]})).unwrap();
assert_eq!(r.values, Some(vec![1, 2, 3]));
assert_eq!(SKIP_COUNT.with(Cell::get), 2);
}
}
pub trait IntoOption<T> {
fn into_option(self) -> Option<T>;
}
impl<T> IntoOption<T> for Option<T> {
fn into_option(self) -> Option<T> {
self
}
}
impl<T> IntoOption<T> for T {
fn into_option(self) -> Option<T> {
Some(self)
}
}
impl IntoOption<String> for &str {
fn into_option(self) -> Option<String> {
Some(self.into())
}
}
impl IntoOption<String> for &mut str {
fn into_option(self) -> Option<String> {
Some(self.into())
}
}
impl IntoOption<String> for &String {
fn into_option(self) -> Option<String> {
Some(self.into())
}
}
impl IntoOption<String> for Box<str> {
fn into_option(self) -> Option<String> {
Some(self.into())
}
}
impl IntoOption<String> for Cow<'_, str> {
fn into_option(self) -> Option<String> {
Some(self.into())
}
}
impl IntoOption<String> for Arc<str> {
fn into_option(self) -> Option<String> {
Some(self.to_string())
}
}
impl<T: ?Sized + AsRef<OsStr>> IntoOption<PathBuf> for &T {
fn into_option(self) -> Option<PathBuf> {
Some(self.into())
}
}
impl IntoOption<PathBuf> for Box<Path> {
fn into_option(self) -> Option<PathBuf> {
Some(self.into())
}
}
impl IntoOption<PathBuf> for Cow<'_, Path> {
fn into_option(self) -> Option<PathBuf> {
Some(self.into())
}
}
impl IntoOption<serde_json::Value> for &str {
fn into_option(self) -> Option<serde_json::Value> {
Some(self.into())
}
}
impl IntoOption<serde_json::Value> for String {
fn into_option(self) -> Option<serde_json::Value> {
Some(self.into())
}
}
impl IntoOption<serde_json::Value> for Cow<'_, str> {
fn into_option(self) -> Option<serde_json::Value> {
Some(self.into())
}
}
#[allow(missing_docs)]
#[derive(Copy, Clone, Default, PartialEq, PartialOrd, Eq, Ord, Debug, Hash, JsonSchema)]
#[schemars(with = "Option<Option<T>>", inline)]
#[expect(clippy::exhaustive_enums)]
pub enum MaybeUndefined<T> {
#[default]
Undefined,
Null,
Value(T),
}
impl<T> MaybeUndefined<T> {
#[inline]
pub const fn is_undefined(&self) -> bool {
matches!(self, MaybeUndefined::Undefined)
}
#[inline]
pub const fn is_null(&self) -> bool {
matches!(self, MaybeUndefined::Null)
}
#[inline]
pub const fn is_value(&self) -> bool {
matches!(self, MaybeUndefined::Value(_))
}
#[inline]
pub const fn value(&self) -> Option<&T> {
match self {
MaybeUndefined::Value(value) => Some(value),
_ => None,
}
}
#[inline]
pub fn take(self) -> Option<T> {
match self {
MaybeUndefined::Value(value) => Some(value),
_ => None,
}
}
#[inline]
pub const fn as_opt_ref(&self) -> Option<Option<&T>> {
match self {
MaybeUndefined::Undefined => None,
MaybeUndefined::Null => Some(None),
MaybeUndefined::Value(value) => Some(Some(value)),
}
}
#[inline]
pub fn as_opt_deref<U>(&self) -> Option<Option<&U>>
where
U: ?Sized,
T: Deref<Target = U>,
{
match self {
MaybeUndefined::Undefined => None,
MaybeUndefined::Null => Some(None),
MaybeUndefined::Value(value) => Some(Some(&**value)),
}
}
#[inline]
pub fn contains_value<U>(&self, x: &U) -> bool
where
U: PartialEq<T>,
{
match self {
MaybeUndefined::Value(y) => x == y,
_ => false,
}
}
#[inline]
pub fn contains<U>(&self, x: Option<&U>) -> bool
where
U: PartialEq<T>,
{
match self {
MaybeUndefined::Value(y) => matches!(x, Some(v) if v == y),
MaybeUndefined::Null => x.is_none(),
MaybeUndefined::Undefined => false,
}
}
#[inline]
pub fn map<U, F: FnOnce(Option<T>) -> Option<U>>(self, f: F) -> MaybeUndefined<U> {
match self {
MaybeUndefined::Value(v) => match f(Some(v)) {
Some(v) => MaybeUndefined::Value(v),
None => MaybeUndefined::Null,
},
MaybeUndefined::Null => match f(None) {
Some(v) => MaybeUndefined::Value(v),
None => MaybeUndefined::Null,
},
MaybeUndefined::Undefined => MaybeUndefined::Undefined,
}
}
#[inline]
pub fn map_value<U, F: FnOnce(T) -> U>(self, f: F) -> MaybeUndefined<U> {
match self {
MaybeUndefined::Value(v) => MaybeUndefined::Value(f(v)),
MaybeUndefined::Null => MaybeUndefined::Null,
MaybeUndefined::Undefined => MaybeUndefined::Undefined,
}
}
pub fn update_to(self, value: &mut Option<T>) {
match self {
MaybeUndefined::Value(new) => *value = Some(new),
MaybeUndefined::Null => *value = None,
MaybeUndefined::Undefined => {}
}
}
}
impl<T, E> MaybeUndefined<Result<T, E>> {
#[inline]
pub fn transpose(self) -> Result<MaybeUndefined<T>, E> {
match self {
MaybeUndefined::Undefined => Ok(MaybeUndefined::Undefined),
MaybeUndefined::Null => Ok(MaybeUndefined::Null),
MaybeUndefined::Value(Ok(v)) => Ok(MaybeUndefined::Value(v)),
MaybeUndefined::Value(Err(e)) => Err(e),
}
}
}
impl<T: Serialize> Serialize for MaybeUndefined<T> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
match self {
MaybeUndefined::Value(value) => value.serialize(serializer),
MaybeUndefined::Null => serializer.serialize_none(),
MaybeUndefined::Undefined => serializer.serialize_unit(),
}
}
}
impl<'de, T> Deserialize<'de> for MaybeUndefined<T>
where
T: Deserialize<'de>,
{
fn deserialize<D>(deserializer: D) -> Result<MaybeUndefined<T>, D::Error>
where
D: Deserializer<'de>,
{
Option::<T>::deserialize(deserializer).map(|value| match value {
Some(value) => MaybeUndefined::Value(value),
None => MaybeUndefined::Null,
})
}
}
impl<T> From<MaybeUndefined<T>> for Option<Option<T>> {
fn from(maybe_undefined: MaybeUndefined<T>) -> Self {
match maybe_undefined {
MaybeUndefined::Undefined => None,
MaybeUndefined::Null => Some(None),
MaybeUndefined::Value(value) => Some(Some(value)),
}
}
}
impl<T> From<Option<Option<T>>> for MaybeUndefined<T> {
fn from(value: Option<Option<T>>) -> Self {
match value {
Some(Some(value)) => Self::Value(value),
Some(None) => Self::Null,
None => Self::Undefined,
}
}
}
pub trait IntoMaybeUndefined<T> {
fn into_maybe_undefined(self) -> MaybeUndefined<T>;
}
impl<T> IntoMaybeUndefined<T> for T {
fn into_maybe_undefined(self) -> MaybeUndefined<T> {
MaybeUndefined::Value(self)
}
}
impl<T> IntoMaybeUndefined<T> for Option<T> {
fn into_maybe_undefined(self) -> MaybeUndefined<T> {
match self {
Some(value) => MaybeUndefined::Value(value),
None => MaybeUndefined::Null,
}
}
}
impl<T> IntoMaybeUndefined<T> for MaybeUndefined<T> {
fn into_maybe_undefined(self) -> MaybeUndefined<T> {
self
}
}
impl IntoMaybeUndefined<String> for &str {
fn into_maybe_undefined(self) -> MaybeUndefined<String> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<String> for &mut str {
fn into_maybe_undefined(self) -> MaybeUndefined<String> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<String> for &String {
fn into_maybe_undefined(self) -> MaybeUndefined<String> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<String> for Box<str> {
fn into_maybe_undefined(self) -> MaybeUndefined<String> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<String> for Cow<'_, str> {
fn into_maybe_undefined(self) -> MaybeUndefined<String> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<String> for Arc<str> {
fn into_maybe_undefined(self) -> MaybeUndefined<String> {
MaybeUndefined::Value(self.to_string())
}
}
impl<T: ?Sized + AsRef<OsStr>> IntoMaybeUndefined<PathBuf> for &T {
fn into_maybe_undefined(self) -> MaybeUndefined<PathBuf> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<PathBuf> for Box<Path> {
fn into_maybe_undefined(self) -> MaybeUndefined<PathBuf> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<PathBuf> for Cow<'_, Path> {
fn into_maybe_undefined(self) -> MaybeUndefined<PathBuf> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<serde_json::Value> for &str {
fn into_maybe_undefined(self) -> MaybeUndefined<serde_json::Value> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<serde_json::Value> for String {
fn into_maybe_undefined(self) -> MaybeUndefined<serde_json::Value> {
MaybeUndefined::Value(self.into())
}
}
impl IntoMaybeUndefined<serde_json::Value> for Cow<'_, str> {
fn into_maybe_undefined(self) -> MaybeUndefined<serde_json::Value> {
MaybeUndefined::Value(self.into())
}
}
#[cfg(test)]
mod tests {
use serde::{Deserialize, Serialize};
use serde_json::{from_value, json, to_value};
use super::*;
#[test]
fn test_maybe_undefined_serde() {
#[derive(Serialize, Deserialize, Eq, PartialEq, Debug)]
struct A {
#[serde(default, skip_serializing_if = "MaybeUndefined::is_undefined")]
a: MaybeUndefined<i32>,
}
assert_eq!(to_value(MaybeUndefined::Value(100i32)).unwrap(), json!(100));
assert_eq!(
from_value::<MaybeUndefined<i32>>(json!(100)).unwrap(),
MaybeUndefined::Value(100)
);
assert_eq!(
from_value::<MaybeUndefined<i32>>(json!(null)).unwrap(),
MaybeUndefined::Null
);
assert_eq!(
to_value(&A {
a: MaybeUndefined::Value(100i32)
})
.unwrap(),
json!({"a": 100})
);
assert_eq!(
to_value(&A {
a: MaybeUndefined::Null,
})
.unwrap(),
json!({ "a": null })
);
assert_eq!(
to_value(&A {
a: MaybeUndefined::Undefined,
})
.unwrap(),
json!({})
);
assert_eq!(
from_value::<A>(json!({"a": 100})).unwrap(),
A {
a: MaybeUndefined::Value(100i32)
}
);
assert_eq!(
from_value::<A>(json!({ "a": null })).unwrap(),
A {
a: MaybeUndefined::Null
}
);
assert_eq!(
from_value::<A>(json!({})).unwrap(),
A {
a: MaybeUndefined::Undefined
}
);
}
#[test]
fn test_maybe_undefined_to_nested_option() {
assert_eq!(Option::<Option<i32>>::from(MaybeUndefined::Undefined), None);
assert_eq!(
Option::<Option<i32>>::from(MaybeUndefined::Null),
Some(None)
);
assert_eq!(
Option::<Option<i32>>::from(MaybeUndefined::Value(42)),
Some(Some(42))
);
}
#[test]
fn test_as_opt_ref() {
let value = MaybeUndefined::<String>::Undefined;
let r = value.as_opt_ref();
assert_eq!(r, None);
let value = MaybeUndefined::<String>::Null;
let r = value.as_opt_ref();
assert_eq!(r, Some(None));
let value = MaybeUndefined::<String>::Value("abc".to_string());
let r = value.as_opt_ref();
assert_eq!(r, Some(Some(&"abc".to_string())));
}
#[test]
fn test_as_opt_deref() {
let value = MaybeUndefined::<String>::Undefined;
let r = value.as_opt_deref();
assert_eq!(r, None);
let value = MaybeUndefined::<String>::Null;
let r = value.as_opt_deref();
assert_eq!(r, Some(None));
let value = MaybeUndefined::<String>::Value("abc".to_string());
let r = value.as_opt_deref();
assert_eq!(r, Some(Some("abc")));
}
#[test]
fn test_contains_value() {
let test = "abc";
let mut value: MaybeUndefined<String> = MaybeUndefined::Undefined;
assert!(!value.contains_value(&test));
value = MaybeUndefined::Null;
assert!(!value.contains_value(&test));
value = MaybeUndefined::Value("abc".to_string());
assert!(value.contains_value(&test));
}
#[test]
fn test_contains() {
let test = Some("abc");
let none: Option<&str> = None;
let mut value: MaybeUndefined<String> = MaybeUndefined::Undefined;
assert!(!value.contains(test.as_ref()));
assert!(!value.contains(none.as_ref()));
value = MaybeUndefined::Null;
assert!(!value.contains(test.as_ref()));
assert!(value.contains(none.as_ref()));
value = MaybeUndefined::Value("abc".to_string());
assert!(value.contains(test.as_ref()));
assert!(!value.contains(none.as_ref()));
}
#[test]
fn test_map_value() {
let mut value: MaybeUndefined<i32> = MaybeUndefined::Undefined;
assert_eq!(value.map_value(|v| v > 2), MaybeUndefined::Undefined);
value = MaybeUndefined::Null;
assert_eq!(value.map_value(|v| v > 2), MaybeUndefined::Null);
value = MaybeUndefined::Value(5);
assert_eq!(value.map_value(|v| v > 2), MaybeUndefined::Value(true));
}
#[test]
fn test_map() {
let mut value: MaybeUndefined<i32> = MaybeUndefined::Undefined;
assert_eq!(value.map(|v| Some(v.is_some())), MaybeUndefined::Undefined);
value = MaybeUndefined::Null;
assert_eq!(
value.map(|v| Some(v.is_some())),
MaybeUndefined::Value(false)
);
value = MaybeUndefined::Value(5);
assert_eq!(
value.map(|v| Some(v.is_some())),
MaybeUndefined::Value(true)
);
}
#[test]
fn test_transpose() {
let mut value: MaybeUndefined<Result<i32, &'static str>> = MaybeUndefined::Undefined;
assert_eq!(value.transpose(), Ok(MaybeUndefined::Undefined));
value = MaybeUndefined::Null;
assert_eq!(value.transpose(), Ok(MaybeUndefined::Null));
value = MaybeUndefined::Value(Ok(5));
assert_eq!(value.transpose(), Ok(MaybeUndefined::Value(5)));
value = MaybeUndefined::Value(Err("error"));
assert_eq!(value.transpose(), Err("error"));
}
}