Struct Separated 

pub struct Separated<const SEP: char = ',', A = Same>(/* private fields */);

A sequence that is written as text with a separator, like a,b,c.

This is for lists in places where only text fits, like environment variables and command line arguments. When deserializing, a string (or a lexical atom) is split at the separator SEP (a comma by default) and every piece is deserialized with the adapter A (by default Same) as a lexical atom, so numbers and booleans parse. The empty string is an empty sequence. Sequences are accepted as they are (their elements are not split), so the same type still reads arrays from JSON or TOML. Pieces are not trimmed and there is no escaping, see TrimWhitespace to trim them.

When serializing, the elements are joined with the separator into a string in all formats. Elements have to be strings, numbers, booleans or chars. Values that would not read back are an error: an element that contains the separator and a sequence of a single empty string (which would read back as the empty sequence).

Supported are Vec<T>, VecDeque<T>, BTreeSet<T> and HashSet<T>.

use deser::adapters::{Separated, TrimWhitespace};
use deser::{Deserialize, Serialize};

#[derive(Serialize, Deserialize)]
pub struct Config {
    // `a,b,c`
    #[deser(as = Separated)]
    hosts: Vec<String>,
    // `/usr/bin:/bin`
    #[deser(as = Separated<':'>)]
    search_path: Vec<String>,
    // `80, 443`
    #[deser(as = Separated<',', TrimWhitespace>)]
    ports: Vec<u16>,
}

Trait Implementations

impl<'de, T: Ord + Send, A: Deserialize<'de, T>, const SEP: char> Deserialize<'de, BTreeSet<T>> for Separated<SEP, A>

fn deserialize_into<'out>( out: &'out mut Option<BTreeSet<T>>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<'de, T: Hash + Eq + Send, H: BuildHasher + Default + Send, A: Deserialize<'de, T>, const SEP: char> Deserialize<'de, HashSet<T, H>> for Separated<SEP, A>

fn deserialize_into<'out>( out: &'out mut Option<HashSet<T, H>>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<'de, T: Send, A: Deserialize<'de, T>, const SEP: char> Deserialize<'de, Vec<T>> for Separated<SEP, A>

fn deserialize_into<'out>( out: &'out mut Option<Vec<T>>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<'de, T: Send, A: Deserialize<'de, T>, const SEP: char> Deserialize<'de, VecDeque<T>> for Separated<SEP, A>

fn deserialize_into<'out>( out: &'out mut Option<VecDeque<T>>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<T, A: Serialize<T>, const SEP: char> Serialize<BTreeSet<T>> for Separated<SEP, A>

fn serialize<'a>( value: &'a BTreeSet<T>, state: &mut State, ) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

fn container_shape(value: &T) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.

impl<T, H, A: Serialize<T>, const SEP: char> Serialize<HashSet<T, H>> for Separated<SEP, A>

fn serialize<'a>( value: &'a HashSet<T, H>, state: &mut State, ) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

fn container_shape(value: &T) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.

impl<T, A: Serialize<T>, const SEP: char> Serialize<Vec<T>> for Separated<SEP, A>

fn serialize<'a>( value: &'a Vec<T>, state: &mut State, ) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

fn container_shape(value: &T) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.

impl<T, A: Serialize<T>, const SEP: char> Serialize<VecDeque<T>> for Separated<SEP, A>

fn serialize<'a>( value: &'a VecDeque<T>, state: &mut State, ) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

fn container_shape(value: &T) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.