magnet_rs 0.2.3

User friendly magnetic field calculations in Rust
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

///! # Arguments Module
///! Read in command line arguments using clap
///! For the moment this is limited to:
///! - infile TOML configuration file
///! - outfile: simulation result
///! - silent: boolean
use clap::{App, Arg};

/// Command line arguments struct, infile, outfile, and silent (i.e. emit to stdout)
pub struct Args {
    /// path to input TOML configuation file for running a calculation
    pub infile: String,
    /// path to JSON output file for saving the results of calculation
    pub outfile: Option<String>,
    /// Boolean for remaining silent or writing to stdout
    pub silent: bool,

    pub demo: bool,
}

impl Args {
    /// Parse command line arguments
    pub fn parse() -> Self {
        let matches = App::new("magnet_rs")
            .author("Peter Dunne")
            .version("0.2.2")
            .about("Calculates 2D magnetic fields")
            .arg(
                Arg::with_name("infile")
                    .help("Read from a toml file")
                    .short("i")
                    .long("infile")
                    .takes_value(true),
            )
            .arg(
                Arg::with_name("outfile")
                    .short("o")
                    .long("outfile")
                    .takes_value(true)
                    .help("Write simulation output to a file"),
            )
            .arg(Arg::with_name("silent").short("s").long("silent").help("Silences console output, except for the progress bar"))
            .arg(
                Arg::with_name("demo")
                    .short("d")
                    .long("demo")
                    .help("Runs an example calculation of two square magnets and saves it to example_out.json."),
            )
            .get_matches();

        let infile = matches.value_of("infile").unwrap_or_default().to_string();

        let outfile = if matches.is_present("outfile") {
            Some(matches.value_of("outfile").unwrap_or_default().to_string())
        } else {
            None
        };

        let demo = matches.is_present("demo");

        let silent = matches.is_present("silent");
        Self {
            infile,
            outfile,
            silent,
            demo,
        }
    }
}