actix-toml
A Rust crate that allows for configuring actix-web
's HttpServer instance through a TOML
file.
Usage
Add this to your Cargo.toml
:
[dependencies]
actix-toml = "0.5"
actix-web = "3.1"
env_logger = "0.8"
Basic usage
Import these items into your crate:
use actix_toml::{ApplySettings, AtResult, Settings};
use actix_web::http::ContentEncoding;
use std::sync::Arc;
They can be used like this:
#[actix_rt::main]
async fn main() -> std::io::Result<()> {
let mut settings = Settings::parse_toml("Server.toml")
.expect("Failed to parse `Settings` from Server.toml");
Settings::override_field_with_env_var(
&mut settings.actix.hosts,
"APPLICATION__HOSTS"
)?;
init_logger(&settings);
let settings = Arc::new(settings); let settings2 = Arc::clone(&settings);
HttpServer::new(move || {
App::new()
.wrap(Compress::new(if settings2.enable_compression {
ContentEncoding::Deflate
} else {
ContentEncoding::Identity
}))
.wrap(Logger::default())
.data(settings2.clone()) .service(index) })
.apply_settings(&settings) .run()
.await
}
fn init_logger(settings: &Settings) {
if !settings.actix.enable_log { return }
std::env::set_var("RUST_LOG", match settings.actix.mode {
Mode::Development => "actix_web=debug",
Mode::Production => "actix_web=info",
});
std::env::set_var("RUST_BACKTRACE", "1");
env_logger::init();
}
Custom Settings
There is a way to extend the available settings. This can be used to combine
the settings provided by actix-web
and those provided by application server
built using actix
.
Have a look at the override_extended_field_with_custom_type
test
in src/lib.rs
to see how.
WIP
The main feature that would be nice to have but currently is not implemented,
is SSL
-support. If you're interested, please contact me or send a PR.
Special Thanks
This crate was made possible by support from Accept B.V.