args 2.2.0

An argument parsing and validation library designed to take some of tediousness out of the general 'getopts' crate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use std::str::FromStr;

use super::super::{Args,ArgsError};
use super::super::validations::Validation;

/// A trait designed to bind parsed arguments and instance methods to a struct.
pub trait HasParsedArgs: Send {
    // Instance methods
    /// Returns a references to the parsed `Args` struct.
    fn parsed_args(&self) -> &Args;

    // Defaulted instance methods
    /// Acts as a convenience method for calling the `Args` implementation.
    fn has_value(&self, opt_name: &str) -> bool {
        self.parsed_args().has_value(opt_name)
    }

    /// Acts as a convenience method for calling the `Args` implementation.
    fn optional_validated_value_of<T>(&self, opt_name: &str, validations: &[Box<Validation<T=T>>])
                                      -> Result<Option<T>, ArgsError> where T: FromStr {
        if self.has_value(opt_name) {
            Ok(Some(try!(self.validated_value_of::<T>(opt_name, validations))))
        } else {
            Ok(None)
        }
    }

    /// Acts as a convenience method for calling the `Args` implementation.
    fn optional_value_of<T: FromStr>(&self, opt_name: &str) -> Result<Option<T>, ArgsError> {
        if self.has_value(opt_name) {
            Ok(Some(try!(self.value_of::<T>(opt_name))))
        } else {
            Ok(None)
        }
    }

    /// Acts as a convenience method for calling the `Args` implementation.
    fn validated_value_of<T>(&self, opt_name: &str, validations: &[Box<Validation<T=T>>])
        -> Result<T, ArgsError> where T: FromStr {
        self.parsed_args().validated_value_of::<T>(opt_name, validations)
    }

    /// Acts as a convenience method for calling the `Args` implementation.
    fn value_of<T: FromStr>(&self, opt_name: &str) -> Result<T, ArgsError> {
        self.parsed_args().value_of::<T>(opt_name)
    }
}