Struct serde_with::StringWithSeparator

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

De/Serialize a delimited collection using Display and FromStr implementation

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.

Converting to serde_as

The same functionality can also be expressed using the serde_as macro. The usage is slightly different. StringWithSeparator takes a second type, which needs to implement Display+FromStr and constitutes the inner type of the collection.

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

Examples

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

#[derive(Deserialize, Serialize)]
struct A {
    #[serde(with = "serde_with::rust::StringWithSeparator::<SpaceSeparator>")]
    tags: Vec<String>,
    #[serde(with = "serde_with::rust::StringWithSeparator::<CommaSeparator>")]
    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()
);

Implementations

impl<Sep> StringWithSeparator<Sep> where
    Sep: Separator, 

pub fn serialize<S, T, V>(values: T, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer,
    T: IntoIterator<Item = V>,
    V: Display, 

Serialize collection into a string with separator symbol

pub fn deserialize<'de, D, T, V>(deserializer: D) -> Result<T, D::Error> where
    D: Deserializer<'de>,
    T: FromIterator<V>,
    V: FromStr,
    V::Err: Display, 

Deserialize a collection from a string with separator symbol

Trait Implementations

impl<Sep: Clone, T: Clone> Clone for StringWithSeparator<Sep, T>

fn clone(&self) -> StringWithSeparator<Sep, T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Sep: Debug, T: Debug> Debug for StringWithSeparator<Sep, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Sep: Default, T: Default> Default for StringWithSeparator<Sep, T>

fn default() -> StringWithSeparator<Sep, T>

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl<Sep: Hash, T: Hash> Hash for StringWithSeparator<Sep, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<Sep: Ord, T: Ord> Ord for StringWithSeparator<Sep, T>

fn cmp(&self, other: &StringWithSeparator<Sep, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Sep: PartialEq, T: PartialEq> PartialEq<StringWithSeparator<Sep, T>> for StringWithSeparator<Sep, T>

fn eq(&self, other: &StringWithSeparator<Sep, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StringWithSeparator<Sep, T>) -> bool

This method tests for !=.

impl<Sep: PartialOrd, T: PartialOrd> PartialOrd<StringWithSeparator<Sep, T>> for StringWithSeparator<Sep, T>

fn partial_cmp(&self, other: &StringWithSeparator<Sep, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

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

Serialize this value into the given Serde serializer.

impl<Sep: Copy, T: Copy> Copy for StringWithSeparator<Sep, T>

impl<Sep: Eq, T: Eq> Eq for StringWithSeparator<Sep, T>

impl<Sep, T> StructuralEq for StringWithSeparator<Sep, T>

impl<Sep, T> StructuralPartialEq for StringWithSeparator<Sep, T>