Struct tor_config::Flatten

pub struct Flatten<T, U>(pub T, pub U);

Helper for flattening deserialisation, compatible with serde_ignored

A combination of two structs T and U.

The serde representation flattens both structs into a single, larger, struct.

Furthermore, unlike plain use of #[serde(flatten)], serde_ignored will still detect fields which appear in serde input but which form part of neither T nor U.

T and U must both be Flattenable. Usually that trait should be derived with the Flattenable macro.

If it’s desired to combine more than two structs, Flatten can be nested.

Limitations

Field name overlaps are not detected. Fields which appear in both structs will be processed as part of T during deserialization. They will be internally presented as duplicate fields during serialization, with the outcome depending on the data format implementation.

Example

use serde::{Serialize, Deserialize};
use derive_adhoc::Adhoc;
use tor_config::{Flatten, derive_adhoc_template_Flattenable};

#[derive(Serialize, Deserialize, Debug, Adhoc, Eq, PartialEq)]
#[derive_adhoc(Flattenable)]
struct A {
    a: i32,
}

#[derive(Serialize, Deserialize, Debug, Adhoc, Eq, PartialEq)]
#[derive_adhoc(Flattenable)]
struct B {
    b: String,
}

let combined: Flatten<A,B> = toml::from_str(r#"
    a = 42
    b = "hello"
"#).unwrap();

assert_eq!(
   combined,
   Flatten(A { a: 42 }, B { b: "hello".into() }),
);

Tuple Fields

0: T

1: U

Trait Implementations

impl<T: Clone, U: Clone> Clone for Flatten<T, U>

fn clone(&self) -> Flatten<T, U>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, U: Debug> Debug for Flatten<T, U>

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

Formats the value using the given formatter.

impl<T: Default, U: Default> Default for Flatten<T, U>

fn default() -> Flatten<T, U>

Returns the “default value” for a type.

impl<'de, T, U> Deserialize<'de> for Flatten<T, U>where T: Deserialize<'de> + Flattenable, U: Deserialize<'de> + Flattenable,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, U> Flattenable for Flatten<T, U>where T: Flattenable, U: Flattenable,

Flatten may be nested

fn has_field(f: &str) -> bool

Does this type have a field named s ?

impl<T: Hash, U: Hash> Hash for Flatten<T, U>

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord, U: Ord> Ord for Flatten<T, U>

fn cmp(&self, other: &Flatten<T, U>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq, U: PartialEq> PartialEq for Flatten<T, U>

fn eq(&self, other: &Flatten<T, U>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd, U: PartialOrd> PartialOrd for Flatten<T, U>

fn partial_cmp(&self, other: &Flatten<T, U>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<T, U> Serialize for Flatten<T, U>where T: Serialize, U: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy, U: Copy> Copy for Flatten<T, U>

impl<T: Eq, U: Eq> Eq for Flatten<T, U>

impl<T, U> StructuralEq for Flatten<T, U>

impl<T, U> StructuralPartialEq for Flatten<T, U>