Enum Enable 

pub enum Enable<T> {
    On(T),
    Off,
}

Enable<T> is a wrapper that adds one extra field enabled when the T is serialized with Serde. That field can be true, in which case all of the fields for T need to be present, or it can be false at which point all fields of T can be ommited.

The use case is for configuration YAMLs where sections can be toggled on or off.

use serde::{Deserialize, Serialize};
use serde_enabled::Enable;

#[derive(Deserialize, Serialize, Debug, PartialEq, Eq)]
struct Outside {
    inside: Enable<Inside>,
}

#[derive(Deserialize, Serialize, Debug, PartialEq, Eq)]
struct Inside {
    thing: u32,
    other: String,
}

let raw = indoc::indoc! {r#"
    inside:
        enable: false
        thing: 1
        other: "Great"
    "#};

let o: Outside = serde_yaml::from_str(raw).unwrap();

 assert!(!o.inside.is_enabled());

 let raw = indoc::indoc! {r#"
     inside:
         enable: true
         thing: 1
         other: "Great"
     "#};

 let o: Outside = serde_yaml::from_str(raw).unwrap();

  assert!(o.inside.is_enabled());
  assert_eq!(
        o,
        Outside {
           inside: Enable::On(Inside {
            thing: 1,
            other: "Great".into()
        })
        }
    );

Variants

On(T)

Off

Implementations

impl<T> Enable<T>

pub fn into_inner(self) -> Option<T>

Turns the Enable into an Option where Enable::On(T) maps to Option::Some(T) and Enable::Off to None.

pub fn as_ref(&self) -> Option<&T>

pub fn is_enabled(&self) -> bool

pub fn off() -> Enable<T>

pub fn on(inner: T) -> Enable<T>

Trait Implementations

impl<T: Clone> Clone for Enable<T>

fn clone(&self) -> Enable<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Enable<T>

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

Formats the value using the given formatter.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Enable<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Enable<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Serialize> Serialize for Enable<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Enable<T>

impl<T> StructuralPartialEq for Enable<T>