pub struct StringWithSeparator<Sep, T>(_);
Expand description

De/Serialize a delimited collection using Display and FromStr implementation

StringWithSeparator takes a second type, which needs to implement Display+FromStr and constitutes the inner type of the collection. You can define an arbitrary separator, by specifying a type which implements Separator. Some common ones, like space and comma are already predefined and you can find them here.

An empty string deserializes as an empty collection.

Examples

use serde_with::formats::{CommaSeparator, SpaceSeparator};
use std::collections::BTreeSet;

#[serde_as]
#[derive(Deserialize, Serialize)]
struct A {
    #[serde_as(as = "StringWithSeparator::<SpaceSeparator, String>")]
    tags: Vec<String>,
    #[serde_as(as = "StringWithSeparator::<CommaSeparator, String>")]
    more_tags: BTreeSet<String>,
}

let v: A = serde_json::from_str(r##"{
    "tags": "#hello #world",
    "more_tags": "foo,bar,bar"
}"##).unwrap();
assert_eq!(vec!["#hello", "#world"], v.tags);
assert_eq!(2, v.more_tags.len());

let x = A {
    tags: vec!["1".to_string(), "2".to_string(), "3".to_string()],
    more_tags: BTreeSet::new(),
};
assert_eq!(
    r#"{"tags":"1 2 3","more_tags":""}"#,
    serde_json::to_string(&x).unwrap()
);

Trait Implementations§

source§

impl<'de, SEPARATOR, I, T> DeserializeAs<'de, I> for StringWithSeparator<SEPARATOR, T>where SEPARATOR: Separator, I: FromIterator<T>, T: FromStr, T::Err: Display,

source§

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

Deserialize this value from the given Serde deserializer.
source§

impl<SEPARATOR, I, T> SerializeAs<I> for StringWithSeparator<SEPARATOR, T>where SEPARATOR: Separator, for<'x> &'x I: IntoIterator<Item = &'x T>, T: Display,

source§

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

Serialize this value into the given Serde serializer.

Auto Trait Implementations§

§

impl<Sep, T> RefUnwindSafe for StringWithSeparator<Sep, T>where Sep: RefUnwindSafe, T: RefUnwindSafe,

§

impl<Sep, T> Send for StringWithSeparator<Sep, T>where Sep: Send, T: Send,

§

impl<Sep, T> Sync for StringWithSeparator<Sep, T>where Sep: Sync, T: Sync,

§

impl<Sep, T> Unpin for StringWithSeparator<Sep, T>where Sep: Unpin, T: Unpin,

§

impl<Sep, T> UnwindSafe for StringWithSeparator<Sep, T>where Sep: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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.