byre 0.2.0

A set of libs for quickly bootstrapping a project
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

use std::path::PathBuf;

use clap::Parser;
use doku::Document;
use serde::{Deserialize, Serialize};

/// Top Level Settings
#[derive(Document, Deserialize)]
pub struct Settings {
    /// App Settings
    pub application: Application,

    /// Telemetry settings.
    pub telemetry: byre::telemetry::TelemetrySettings,
}

#[derive(Document, Deserialize)]
pub struct Application {
    /// Port to listen on
    #[doku(example = "8080")]
    pub listen_port: u16,

    /// Hostname to listen to
    #[doku(example = "localhost")]
    pub listen_host: String,

    /// Directory where the application databases are located
    #[doku(example = "/var/db/my_databases")]
    pub application_db_dir: PathBuf,
}

#[derive(Parser, Deserialize, Serialize)]
/// A NEW description, not using the one from Cargo.toml!
pub struct Arguments {
    /// world peace, careful, has consequences
    #[arg(short, long)]
    pub enable_world_peace: bool,

    /// This value will be overridden by
    #[arg(short, long)]
    pub override_me: bool,
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Parse command line arguments. Add additional command line option that allows checking
    // the config without running the server.
    let service_info = byre::service_info!();
    let cli = byre::cli::Cli::<Settings, Arguments>::new(&service_info, "MYAPP_");

    let _telemetry = byre::telemetry::init(&service_info, &cli.config.telemetry)?;

    // Find the SocketAddr that we should bind to
    let _listen_port = cli.config.application.listen_port;
    let _listen_hostname = cli.config.application.listen_host;

    // Check if world peace has been enabled
    if cli.args.enable_world_peace {
        // ...
    }

    Ok(())
}