rusht 1.1.0

Shell commands written in Rust
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
49
50
51
52
53

use ::std::time::Duration;

use ::clap::StructOpt;
use ::parse_duration0::parse as parse_dur;

use crate::common::CommandArgs;

#[derive(StructOpt, Debug)]
#[structopt(
    name = "locked",
    about = "Do not start a command until a given lock is released."
)]
pub struct LockedArgs {
    #[structopt(short = 'f', long = "lock-key", default_value = "%{pwd}.lock")]
    /// The key to use for the lock. Only other commands with the same key are blocked. Can use %{pwd} and %{cmd} placeholders. Defaults to current directory.
    //TODO @mverleg: impl
    pub lock_key: String,
    #[structopt(
        parse(try_from_str = parse_dur),
        short = 't',
        long = "timeout",
        default_value = "15 min"
    )]
    /// Duration after which the waiting stops and the command fails. E.g. \"30 min\" or \"1 day -1 hour\".
    //TODO @mverleg: impl
    pub timeout: Duration,
    #[structopt(short = 'p', long = "progress")]
    /// Show an indicator that we are still waiting, what is running, and how frequently we are checking.
    //TODO @mverleg: impl
    pub show_progress: bool,
    #[structopt(short = 'r', long = "read")]
    /// Mark the current process as a reader instead of a writer. Multiple readers may hold the lock simultaneously. The process should not make any changes.
    //TODO @mverleg: impl
    pub read: bool,
    #[structopt(short = 's', long = "show")]
    /// Instead of running a command, show the command(s) that currently hold the lock.
    //TODO @mverleg: impl
    pub show: bool,
    #[structopt(long = "unlock")]
    /// Instead of running a command, remove the current lockfile. Should only be used if you are confident that the lock is held incorrectly.
    //TODO @mverleg: impl
    pub unlock: bool,
    #[structopt(subcommand)]
    //TODO @mverleg: impl
    pub cmd: CommandArgs,
}
//TODO @mverleg: allow multiple readers or one writer

#[test]
fn test_cli_args() {
    use clap::IntoApp;
    LockedArgs::into_app().debug_assert()
}