Trait smart_config::de::WellKnown

pub trait WellKnown: 'static + Sized {
    type Deserializer: DeserializeParam<Self>;

    const DE: Self::Deserializer;
}

Parameter type with well-known deserializer.

Conceptually, this means that the type is known to behave well when deserializing data from a Value (ordinarily, using serde::Deserialize).

Implementations

Basic well-known types include:

• bool
• String
• PathBuf
• Signed and unsigned integers, including non-zero variants
• f32, f64

These types use Serde deserializer.

WellKnown is also implemented for more complex types:

Rust type	Deserializer	Expected JSON
Duration	WithUnit	string or object
ByteSize	WithUnit	string or object
Option	Optional†	value, or null, or nothing
Vec, [_; N], HashSet, BTreeSet	Repeated	array
HashMap, BTreeMap	RepeatedEntries	object

† Options handling can be customized via WellKnownOption or CustomKnownOption traits.

Required Associated Types

type Deserializer: DeserializeParam<Self>

Type of the deserializer used for this type.

Required Associated Constants

const DE: Self::Deserializer

Deserializer instance.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl WellKnown for IpAddr

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for SocketAddr

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for bool

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for f32

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for f64

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for i8

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for i16

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for i32

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for i64

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for i128

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for isize

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for u8

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for u16

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for u32

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for u64

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for u128

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for usize

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for String

type Deserializer = Serde<{ $crate::_basic_types!($($expecting)+) }>

const DE: Self::Deserializer = _

impl WellKnown for Ipv4Addr

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for Ipv6Addr

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for SocketAddrV4

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for SocketAddrV6

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for Duration

type Deserializer = WithUnit

const DE: Self::Deserializer = WithUnit

impl WellKnown for PathBuf

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroI8

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroI16

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroI32

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroI64

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroIsize

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroU8

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroU16

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroU32

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroU64

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for NonZeroUsize

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = _

impl WellKnown for H128

Available on crate feature primitive-types only.

Accepts a hex string with an optional 0x prefix.

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = HASH_DE

impl WellKnown for H160

Available on crate feature primitive-types only.

Accepts a hex string with an optional 0x prefix.

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = HASH_DE

impl WellKnown for H256

Available on crate feature primitive-types only.

Accepts a hex string with an optional 0x prefix.

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = HASH_DE

impl WellKnown for H384

Available on crate feature primitive-types only.

Accepts a hex string with an optional 0x prefix.

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = HASH_DE

impl WellKnown for H512

Available on crate feature primitive-types only.

Accepts a hex string with an optional 0x prefix.

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = HASH_DE

impl WellKnown for H768

Available on crate feature primitive-types only.

Accepts a hex string with an optional 0x prefix.

type Deserializer = Qualified<Serde<{ $crate::_basic_types!($($expecting)+) }>>

const DE: Self::Deserializer = HASH_DE

impl WellKnown for U128

Available on crate feature primitive-types only.

Accepts a hex string with an mandatory 0x prefix. This prefix is required to clearly signal hex encoding so that "34" doesn’t get mistaken for decimal 34.

type Deserializer = HexUintDeserializer

const DE: Self::Deserializer = HexUintDeserializer

impl WellKnown for U256

Available on crate feature primitive-types only.

Accepts a hex string with an mandatory 0x prefix. This prefix is required to clearly signal hex encoding so that "34" doesn’t get mistaken for decimal 34.

type Deserializer = HexUintDeserializer

const DE: Self::Deserializer = HexUintDeserializer

impl WellKnown for U512

Available on crate feature primitive-types only.

Accepts a hex string with an mandatory 0x prefix. This prefix is required to clearly signal hex encoding so that "34" doesn’t get mistaken for decimal 34.

type Deserializer = HexUintDeserializer

const DE: Self::Deserializer = HexUintDeserializer

impl<K, V> WellKnown for BTreeMap<K, V>

where K: 'static + Eq + Ord + WellKnown, V: 'static + WellKnown,

type Deserializer = Entries<K, V>

const DE: Self::Deserializer = _

impl<K, V, S> WellKnown for HashMap<K, V, S>

where K: 'static + Eq + Hash + WellKnown, V: 'static + WellKnown, S: 'static + Default + BuildHasher,

type Deserializer = Entries<K, V>

const DE: Self::Deserializer = _

impl<T> WellKnown for BTreeSet<T>

where T: Eq + Ord + WellKnown,

type Deserializer = Repeated<<T as WellKnown>::Deserializer>

const DE: Self::Deserializer = _

impl<T, S> WellKnown for HashSet<T, S>

where T: Eq + Hash + WellKnown, S: 'static + Default + BuildHasher,

type Deserializer = Repeated<<T as WellKnown>::Deserializer>

const DE: Self::Deserializer = _

impl<T: CustomKnownOption> WellKnown for Option<T>

type Deserializer = <T as CustomKnownOption>::OptDeserializer

const DE: Self::Deserializer = T::OPT_DE

impl<T: WellKnown> WellKnown for Vec<T>

type Deserializer = Repeated<<T as WellKnown>::Deserializer>

const DE: Self::Deserializer = _

impl<T: WellKnown, const N: usize> WellKnown for [T; N]

type Deserializer = Repeated<<T as WellKnown>::Deserializer>

const DE: Self::Deserializer = _

Implementors

impl WellKnown for ByteSize

type Deserializer = WithUnit

const DE: Self::Deserializer = WithUnit

impl WellKnown for SecretString

type Deserializer = FromSecretString

const DE: Self::Deserializer = FromSecretString