Struct ArgDescriptor 

pub struct ArgDescriptor {
    pub name: String,
    pub description: Option<String>,
    pub required: bool,
    pub validator: Option<Box<dyn Fn(&str) -> Result<(), &'static str>>>,
}

Describes a single validator argument.

Examples

Builder:

use memflow::plugins::ArgDescriptor;

let desc = ArgDescriptor::new("cache_size")
    .description("cache_size argument description")
    .required(true);

Fields

name: String

description: Option<String>

required: bool

validator: Option<Box<dyn Fn(&str) -> Result<(), &'static str>>>

Implementations

impl ArgDescriptor

pub fn new(name: &str) -> ArgDescriptor

Creates a new ArgDescriptor with the given argument name.

pub fn description(self, description: &str) -> ArgDescriptor

Set the description for this argument.

By default the description is None.

pub fn required(self, required: bool) -> ArgDescriptor

Set the required state for this argument.

By default arguments are optional.

pub fn validator( self, validator: Box<dyn Fn(&str) -> Result<(), &'static str>>, ) -> ArgDescriptor

Sets the validator function for this argument.

By default no validator is set.

Examples

use memflow::plugins::ArgDescriptor;

let desc = ArgDescriptor::new("cache_size").validator(Box::new(|arg| {
    match arg == "valid_option" {
        true => Ok(()),
        false => Err("argument must be 'valid_option'"),
    }
}));

Trait Implementations

impl Debug for ArgDescriptor

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

Formats the value using the given formatter.

impl Display for ArgDescriptor

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

Formats the value using the given formatter.