Struct serde_with::rust::StringWithSeparator

[+] Show declaration

pub struct StringWithSeparator<Sep>(_);

[−] 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.

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> Clone for StringWithSeparator<Sep>[+]

[+] Show hidden undocumented items

fn clone(&self) -> StringWithSeparator<Sep>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

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

impl<Sep: Debug> Debug for StringWithSeparator<Sep>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<Sep: Default> Default for StringWithSeparator<Sep>[+]

[+] Show hidden undocumented items

fn default() -> StringWithSeparator<Sep>[−]

Returns the “default value” for a type.

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

impl<Sep: Hash> Hash for StringWithSeparator<Sep>[+]

[+] Show hidden undocumented items

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

Feeds this value into the given Hasher.

pub 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> Ord for StringWithSeparator<Sep>[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &StringWithSeparator<Sep>) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl<Sep: PartialEq> PartialEq<StringWithSeparator<Sep>> for StringWithSeparator<Sep>[+]

[+] Show hidden undocumented items

fn eq(&self, other: &StringWithSeparator<Sep>) -> bool[−]

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

fn ne(&self, other: &StringWithSeparator<Sep>) -> bool[−]

This method tests for !=.

impl<Sep: PartialOrd> PartialOrd<StringWithSeparator<Sep>> for StringWithSeparator<Sep>[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

#[must_use]pub fn lt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]pub fn le(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]pub fn gt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]pub 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<Sep> StructuralEq for StringWithSeparator<Sep>

impl<Sep> StructuralPartialEq for StringWithSeparator<Sep>