Struct serde_with::rust::StringWithSeparator [−][src]
pub struct StringWithSeparator<Sep, T = ()>(_);
Expand description
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]
impl<Sep> StringWithSeparator<Sep> where
Sep: Separator,
[src]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]
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]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]
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]Deserialize a collection from a string with separator symbol
Trait Implementations
impl<Sep: Clone, T: Clone> Clone for StringWithSeparator<Sep, T>
[src]
impl<Sep: Clone, T: Clone> Clone for StringWithSeparator<Sep, T>
[src]fn clone(&self) -> StringWithSeparator<Sep, T>
[src]
fn clone(&self) -> StringWithSeparator<Sep, T>
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl<Sep: Debug, T: Debug> Debug 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]
impl<Sep: Default, T: Default> Default for StringWithSeparator<Sep, T>
[src]fn default() -> StringWithSeparator<Sep, T>
[src]
fn default() -> StringWithSeparator<Sep, T>
[src]Returns the “default value” for a type. Read more
impl<'de, SEPARATOR, I, T> DeserializeAs<'de, I> for StringWithSeparator<SEPARATOR, T> where
SEPARATOR: Separator,
I: FromIterator<T>,
T: FromStr,
T::Err: Display,
[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]fn deserialize_as<D>(deserializer: D) -> Result<I, D::Error> where
D: Deserializer<'de>,
[src]
fn deserialize_as<D>(deserializer: D) -> Result<I, D::Error> where
D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer.
impl<Sep: Hash, T: Hash> Hash for StringWithSeparator<Sep, T>
[src]
impl<Sep: Hash, T: Hash> Hash for StringWithSeparator<Sep, T>
[src]impl<Sep: Ord, T: Ord> Ord for StringWithSeparator<Sep, T>
[src]
impl<Sep: Ord, T: Ord> Ord for StringWithSeparator<Sep, T>
[src]impl<Sep: PartialEq, T: PartialEq> PartialEq<StringWithSeparator<Sep, T>> for StringWithSeparator<Sep, T>
[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 eq(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]
fn ne(&self, other: &StringWithSeparator<Sep, T>) -> bool
[src]This method tests for !=
.
impl<Sep: PartialOrd, T: PartialOrd> PartialOrd<StringWithSeparator<Sep, T>> for StringWithSeparator<Sep, T>
[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 partial_cmp(&self, other: &StringWithSeparator<Sep, T>) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<SEPARATOR, I, T> SerializeAs<I> for StringWithSeparator<SEPARATOR, T> where
SEPARATOR: Separator,
&'a I: IntoIterator<Item = &'a T>,
T: ToString,
[src]
impl<SEPARATOR, I, T> SerializeAs<I> for StringWithSeparator<SEPARATOR, T> where
SEPARATOR: Separator,
&'a I: IntoIterator<Item = &'a T>,
T: ToString,
[src]fn serialize_as<S>(source: &I, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
[src]
fn serialize_as<S>(source: &I, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
[src]Serialize this value into the given Serde serializer.
impl<Sep: Copy, T: Copy> Copy for StringWithSeparator<Sep, T>
[src]
impl<Sep: Eq, T: Eq> Eq for StringWithSeparator<Sep, T>
[src]
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> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more