cargo-samply 0.3.3

A cargo subcommand to automate the process of running samply for project binaries
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! Command-line interface configuration for cargo-samply.
//!
//! This module defines the CLI structure using `clap` with support for both
//! direct execution (`cargo-samply`) and cargo subcommand usage (`cargo samply`).
//!
//! # Examples
//!
//! ```no_run
//! use cargo_samply::cli::{CargoCli, Config};
//! use clap::Parser;
//!
//! // Parse command-line arguments
//! let CargoCli::Samply(config) = CargoCli::parse();
//! println!("Profile: {}", config.profile);
//! ```

use clap::Parser;

/// The main cargo CLI enum that wraps the samply subcommand.
///
/// This enum is designed to work with cargo's subcommand protocol,
/// allowing the tool to be called as both `cargo samply` and `cargo-samply`.
#[derive(Parser)] // requires `derive` feature
#[command(name = "cargo")]
#[command(bin_name = "cargo")]
#[command(styles = CLAP_STYLING)]
pub enum CargoCli {
    /// The samply subcommand
    Samply(Config),
}

// See also `clap_cargo::style::CLAP_STYLING`
pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    .header(clap_cargo::style::HEADER)
    .usage(clap_cargo::style::USAGE)
    .literal(clap_cargo::style::LITERAL)
    .placeholder(clap_cargo::style::PLACEHOLDER)
    .error(clap_cargo::style::ERROR)
    .valid(clap_cargo::style::VALID)
    .invalid(clap_cargo::style::INVALID);

/// Configuration structure for the cargo-samply command.
///
/// This struct contains all the command-line options and arguments
/// that can be passed to cargo-samply.
///
/// # Examples
///
/// ```no_run
/// use cargo_samply::cli::Config;
///
/// let config = Config {
///     args: vec!["--help".to_string()],
///     profile: "samply".to_string(),
///     bin: Some("my-binary".to_string()),
///     example: None,
///     features: vec!["feature1".to_string(), "feature2".to_string()],
///     no_default_features: false,
///     verbose: false,
///     quiet: false,
///     no_samply: false,
/// };
/// ```
#[derive(clap::Args)]
#[command(author, version, about, long_about = None)]
pub struct Config {
    /// Trailing arguments passed to the binary being profiled
    #[arg(name = "TRAILING_ARGUMENTS")]
    pub args: Vec<String>,

    /// Build with the specified profile
    #[arg(short, long, default_value = "samply")]
    pub profile: String,

    /// Binary to run
    #[arg(short, long)]
    pub bin: Option<String>,

    /// Example to run
    #[arg(short, long)]
    pub example: Option<String>,

    /// Build features to enable
    #[arg(short, long)]
    pub features: Vec<String>,

    /// Disable default features
    #[arg(long)]
    pub no_default_features: bool,

    /// Print extra output to help debug problems
    #[arg(short, long, default_value_t = false)]
    pub verbose: bool,

    /// Suppress all output except errors
    #[arg(short, long, default_value_t = false)]
    pub quiet: bool,

    /// Disable the automatic samply start
    #[arg(short, long, default_value_t = false)]
    pub no_samply: bool,
}