Enum SoftErrors 

pub enum SoftErrors<T> {
    All,
    List(Vec<T>),
}

Soft errors deserializer wrapper for URL query strings.

Example

use plugx_config::{
    loader::{SoftErrors, deserialize_query_string},
    ext::{url::Url, serde::Deserialize},
};

// Define an enum for your own errors
#[derive(Debug, PartialEq, Deserialize)]
enum MySoftErrors {
    NotFound,
    Permission,
    Empty,
}

// Define a struct for your own options
// Include your own errors inside your options
#[derive(Debug, PartialEq, Deserialize)]
struct MyOptions {
    // The value should be string `all` or dot seperated values of `MySoftErrors`
    skip_errors: SoftErrors<MySoftErrors>,
    // Other options ...
}

// `deserialize_query_string` function needs loader name to generate a good descriptive error
let loader_name = "file-loader";

let url = Url::try_from("file://etc/config/file.toml?skip_errors=all").expect("Valid URL");
let options: MyOptions = deserialize_query_string(loader_name, &url).expect("Parse options");
assert_eq!(options, MyOptions{skip_errors: SoftErrors::new_all()});
assert!(options.skip_errors.skip_all());

let url = Url::try_from("file://etc/config/file.toml?skip_errors=NotFound.Permission").expect("Valid URL");
let options: MyOptions = deserialize_query_string(loader_name, &url).expect("Parse options");
let skip_errors = options.skip_errors;
assert!(skip_errors.contains(&MySoftErrors::NotFound));
assert!(skip_errors.contains(&MySoftErrors::Permission));
assert!(!skip_errors.contains(&MySoftErrors::Empty));
assert!(!skip_errors.skip_all());
assert_eq!(
    skip_errors.maybe_soft_error_list(),
      Some(&Vec::from([MySoftErrors::NotFound, MySoftErrors::Permission]))
);

Variants

All

List(Vec<T>)

Implementations

impl<'de, T: Deserialize<'de>> SoftErrors<T>

pub fn new_all() -> Self

pub fn new_list() -> Self

pub fn skip_all(&self) -> bool

pub fn add_soft_error(&mut self, soft_error: T)

pub fn with_soft_error(self, soft_error: T) -> Self

pub fn maybe_soft_error_list(&self) -> Option<&Vec<T>>

pub fn maybe_soft_error_list_mut(&mut self) -> Option<&mut Vec<T>>

impl<'de, T: Deserialize<'de> + PartialEq> SoftErrors<T>

pub fn contains(&self, soft_error: &T) -> bool

Trait Implementations

impl<T: Clone> Clone for SoftErrors<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SoftErrors<T>

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

Formats the value using the given formatter.

impl<'de, T: Deserialize<'de>> Default for SoftErrors<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for SoftErrors<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 SoftErrors<T>

fn eq(&self, other: &SoftErrors<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 for SoftErrors<T>

where T: 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> StructuralPartialEq for SoftErrors<T>