snx 0.0.3

an experimental batteries-included web framework for 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
54
55
56
57

use std::sync::Arc;

use crate::{
    config::Config,
    http::router::Router,
    middleware::{trace_requests, MiddlewareHandler},
    panic_hook::panic_hook,
    Server,
};

/// Describes an snx application with sane defaults.
pub trait App {
    /// Defines the application's routes.
    ///
    /// Sets up an empty router by default.
    fn with_routes() -> Router {
        Router::builder().build().unwrap()
    }

    /// Defines the application's configuration.
    ///
    /// Reads the `snx.toml` at the project root by default.
    fn with_config() -> Config {
        Config::try_from_fs().expect("failed to retrieve config from file `snx.toml`")
    }

    /// Defines the application's global middleware.
    ///
    /// Configures the request tracing middleware by default.
    fn with_global_middleware() -> Vec<MiddlewareHandler> {
        vec![Arc::new(Box::new(trace_requests))]
    }

    /// Defines the application's logging/tracing configuration.
    ///
    /// Sets up a global tracing subcriber with line-oriented logging to stdout by default.
    fn with_tracing() {
        tracing_subscriber::fmt().with_target(false).init();
    }
}

/// Boots the snx framework and starts your application.
pub fn boot<A: App>() {
    let router = A::with_routes();
    let config = A::with_config();
    let global_middleware = A::with_global_middleware();

    A::with_tracing();

    std::panic::set_hook(Box::new(panic_hook));

    let addr = format!("{}:{}", config.server.host, config.server.port);
    Server::try_bind(addr, router, global_middleware)
        .unwrap()
        .num_threads(config.server.num_threads)
        .serve();
}