[−][src]Struct serde_with::StringWithSeparator
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,
[src]
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,
[src]
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,
[src]
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>
[src]
fn clone(&self) -> StringWithSeparator<Sep, T>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<Sep: Copy, T: Copy> Copy for StringWithSeparator<Sep, T>
[src]
impl<Sep: Debug, T: Debug> Debug for StringWithSeparator<Sep, T>
[src]
impl<Sep: Default, T: Default> Default for StringWithSeparator<Sep, T>
[src]
fn default() -> StringWithSeparator<Sep, T>
[src]
impl<'de, SEPARATOR, I, T> DeserializeAs<'de, I> for StringWithSeparator<SEPARATOR, T> where
SEPARATOR: Separator,
I: FromIterator<T>,
T: FromStr,
T::Err: Display,
[src]
SEPARATOR: Separator,
I: FromIterator<T>,
T: FromStr,
T::Err: Display,
fn deserialize_as<D>(deserializer: D) -> Result<I, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
impl<Sep: Eq, T: Eq> Eq for StringWithSeparator<Sep, T>
[src]
impl<Sep: Hash, T: Hash> Hash for StringWithSeparator<Sep, T>
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<Sep: Ord, T: Ord> Ord for StringWithSeparator<Sep, T>
[src]
fn cmp(&self, other: &StringWithSeparator<Sep, T>) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<Sep: PartialEq, T: PartialEq> PartialEq<StringWithSeparator<Sep, T>> for StringWithSeparator<Sep, T>
[src]
fn eq(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]
fn ne(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]
impl<Sep: PartialOrd, T: PartialOrd> PartialOrd<StringWithSeparator<Sep, T>> for StringWithSeparator<Sep, T>
[src]
fn partial_cmp(&self, other: &StringWithSeparator<Sep, T>) -> Option<Ordering>
[src]
fn lt(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]
fn le(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]
fn gt(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]
fn ge(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]
impl<SEPARATOR, I, T> SerializeAs<I> for StringWithSeparator<SEPARATOR, T> where
SEPARATOR: Separator,
&'a I: IntoIterator<Item = &'a T>,
T: ToString,
[src]
SEPARATOR: Separator,
&'a I: IntoIterator<Item = &'a T>,
T: ToString,
fn serialize_as<S>(source: &I, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
[src]
S: Serializer,
impl<Sep, T> StructuralEq for StringWithSeparator<Sep, T>
[src]
impl<Sep, T> StructuralPartialEq for StringWithSeparator<Sep, T>
[src]
Auto Trait Implementations
impl<Sep, T> RefUnwindSafe for StringWithSeparator<Sep, T> where
Sep: RefUnwindSafe,
T: RefUnwindSafe,
Sep: RefUnwindSafe,
T: RefUnwindSafe,
impl<Sep, T> Send for StringWithSeparator<Sep, T> where
Sep: Send,
T: Send,
Sep: Send,
T: Send,
impl<Sep, T> Sync for StringWithSeparator<Sep, T> where
Sep: Sync,
T: Sync,
Sep: Sync,
T: Sync,
impl<Sep, T> Unpin for StringWithSeparator<Sep, T> where
Sep: Unpin,
T: Unpin,
Sep: Unpin,
T: Unpin,
impl<Sep, T> UnwindSafe for StringWithSeparator<Sep, T> where
Sep: UnwindSafe,
T: UnwindSafe,
Sep: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,