Trait smart_config::validation::Validate

pub trait Validate<T: ?Sized>:
    'static
    + Send
    + Sync {
    // Required methods
    fn describe(&self, formatter: &mut Formatter<'_>) -> Result;
    fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>;
}

Generic post-validation for a configuration parameter or a config.

Implementations

Validations are implemented for the following types:

• NotEmpty. Validates that a string or a collection, such as Vec, is not empty.
• Range, RangeInclusive etc. Validates whether the type is within the provided bounds.

Required Methods

fn describe(&self, formatter: &mut Formatter<'_>) -> Result

Describes this validation.

Errors

Should propagate formatting errors.

fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>

Validates a parameter / config.

Errors

Should return an error if validation fails.

Trait Implementations

impl<T: 'static + ?Sized> Debug for dyn Validate<T>

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

Formats the value using the given formatter.

impl<T: 'static + ?Sized> Display for dyn Validate<T>

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

Formats the value using the given formatter.

Implementations on Foreign Types

impl<T> Validate<T> for Range<T>

where T: 'static + Send + Sync + PartialOrd + Debug,

fn describe(&self, formatter: &mut Formatter<'_>) -> Result

fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>

impl<T> Validate<T> for RangeFrom<T>

where T: 'static + Send + Sync + PartialOrd + Debug,

fn describe(&self, formatter: &mut Formatter<'_>) -> Result

fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>

impl<T> Validate<T> for RangeInclusive<T>

where T: 'static + Send + Sync + PartialOrd + Debug,

fn describe(&self, formatter: &mut Formatter<'_>) -> Result

fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>

impl<T> Validate<T> for RangeTo<T>

where T: 'static + Send + Sync + PartialOrd + Debug,

fn describe(&self, formatter: &mut Formatter<'_>) -> Result

fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>

impl<T> Validate<T> for RangeToInclusive<T>

where T: 'static + Send + Sync + PartialOrd + Debug,

fn describe(&self, formatter: &mut Formatter<'_>) -> Result

fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>

impl<T: ?Sized, V: Validate<T> + ?Sized> Validate<T> for &'static V

Delegates via a reference. Useful for defining validation constants as &'static dyn Validate<_>.

fn describe(&self, formatter: &mut Formatter<'_>) -> Result

fn validate(&self, target: &T) -> Result<(), ErrorWithOrigin>

Implementors

impl Validate<String> for NotEmpty

impl<K> Validate<BTreeSet<K>> for NotEmpty

impl<K, S> Validate<HashSet<K, S>> for NotEmpty

impl<K, V> Validate<BTreeMap<K, V>> for NotEmpty

impl<K, V, S> Validate<HashMap<K, V, S>> for NotEmpty

impl<T> Validate<Vec<T>> for NotEmpty