Struct serde_with::OneOrMany

source ·
pub struct OneOrMany<T, FORMAT: Format = PreferOne>(/* private fields */);
Expand description

Deserialize one or many elements

Sometimes it is desirable to have a shortcut in writing 1-element lists in a config file. Usually, this is done by either writing a list or the list element itself. This distinction is not semantically important on the Rust side, thus both forms should deserialize into the same Vec.

The OneOrMany adapter achieves exactly this use case. The serialization behavior can be tweaked to either always serialize as a list using PreferMany or to serialize as the inner element if possible using PreferOne. By default, PreferOne is assumed, which can also be omitted like OneOrMany<_>.

§Examples

#[serde_as]
#[derive(Deserialize, serde::Serialize)]
struct Data {
    #[serde_as(as = "OneOrMany<_, PreferOne>")]
    countries: Vec<String>,
    #[serde_as(as = "OneOrMany<_, PreferMany>")]
    cities: Vec<String>,
}

// The adapter allows deserializing a `Vec` from either
// a single element
let j = json!({
    "countries": "Spain",
    "cities": "Berlin",
});
assert!(serde_json::from_value::<Data>(j).is_ok());

// or from a list.
let j = json!({
    "countries": ["Germany", "France"],
    "cities": ["Amsterdam"],
});
assert!(serde_json::from_value::<Data>(j).is_ok());

// For serialization you can choose how a single element should be encoded.
// Either directly, with `PreferOne` (default), or as a list with `PreferMany`.
let data = Data {
    countries: vec!["Spain".to_string()],
    cities: vec!["Berlin".to_string()],
};
let j = json!({
    "countries": "Spain",
    "cities": ["Berlin"],
});
assert_eq!(serde_json::to_value(data).unwrap(), j);

Trait Implementations§

source§

impl<'de, T, TAs, FORMAT> DeserializeAs<'de, Vec<T>> for OneOrMany<TAs, FORMAT>
where TAs: DeserializeAs<'de, T>, FORMAT: Format,

source§

fn deserialize_as<D>(deserializer: D) -> Result<Vec<T>, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.
source§

impl<T, U> SerializeAs<Vec<T>> for OneOrMany<U, PreferOne>
where U: SerializeAs<T>,

source§

fn serialize_as<S>(source: &Vec<T>, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer.
source§

impl<T, U> SerializeAs<Vec<T>> for OneOrMany<U, PreferMany>
where U: SerializeAs<T>,

source§

fn serialize_as<S>(source: &Vec<T>, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer.

Auto Trait Implementations§

§

impl<T, FORMAT> Freeze for OneOrMany<T, FORMAT>

§

impl<T, FORMAT> RefUnwindSafe for OneOrMany<T, FORMAT>
where T: RefUnwindSafe, FORMAT: RefUnwindSafe,

§

impl<T, FORMAT> Send for OneOrMany<T, FORMAT>
where T: Send, FORMAT: Send,

§

impl<T, FORMAT> Sync for OneOrMany<T, FORMAT>
where T: Sync, FORMAT: Sync,

§

impl<T, FORMAT> Unpin for OneOrMany<T, FORMAT>
where T: Unpin, FORMAT: Unpin,

§

impl<T, FORMAT> UnwindSafe for OneOrMany<T, FORMAT>
where T: UnwindSafe, FORMAT: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.