napali 0.1.1

TUI interface for Integrated Reasoning's accelerated solver API
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

use crate::utils::version;
use clap::Parser;

/// Command-line interface (CLI) arguments for Napali.
///
/// This struct is defined using `clap`, a Rust crate for building CLIs with minimal boilerplate.
/// It parses command-line arguments and provides a user-friendly interface for configuring
/// Napali's settings.
#[derive(Parser, Debug)]
#[command(author, version = version(), about)]
pub struct Cli {
  /// Tick rate configuration for Napali.
  ///
  /// Specifies the number of logic updates (ticks) per second.
  ///
  /// # Arguments
  ///
  /// * `-t`, `--tick_rate`: (Optional) The tick rate as a floating-point number.
  /// * `default_value_t = 1.0`: Default tick rate is set to 1.0 ticks per second.
  #[arg(
    short,
    long,
    value_name = "FLOAT",
    help = "Tick rate, i.e. number of ticks per second",
    default_value_t = 1.0
  )]
  pub tick_rate: f64,

  /// Frame rate configuration for Napali.
  ///
  /// Determines the number of frames rendered per second.
  ///
  /// # Arguments
  ///
  /// * `-f`, `--frame_rate`: (Optional) The frame rate as a floating-point number.
  /// * `default_value_t = 60.0`: Default frame rate is set to 60.0 frames per second.
  #[arg(
    short,
    long,
    value_name = "FLOAT",
    help = "Frame rate, i.e. number of frames per second",
    default_value_t = 60.0
  )]
  pub frame_rate: f64,

  /// Flag to enable or disable the Tokio console subscriber.
  ///
  /// When enabled, it activates the Tokio console subscriber for enhanced diagnostics
  /// and telemetry. Useful for debugging and performance monitoring in Tokio-based
  /// asynchronous applications.
  ///
  /// # Arguments
  ///
  /// * `-c`, `--console_subscriber`: (Optional) Boolean flag to enable the subscriber.
  /// * `default_value_t = false`: Disabled by default.
  #[arg(
    short,
    long,
    value_name = "BOOL",
    help = "Enable Tokio console subscriber",
    default_value_t = false
  )]
  pub console_subscriber: bool,
}