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 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use config::{Result, Config, Value, Environment, Limits, LoggingLevel};
/// Structure following the builder pattern for building `Config` structures.
#[derive(Clone)]
pub struct ConfigBuilder {
/// The environment that this configuration corresponds to.
pub environment: Environment,
/// The address to serve on.
pub address: String,
/// The port to serve on.
pub port: u16,
/// The number of workers to run in parallel.
pub workers: u16,
/// Keep-alive timeout in seconds or disabled if 0.
pub keep_alive: u32,
/// Number of seconds to wait without _receiving_ data before closing a
/// connection; disabled when `None`.
pub read_timeout: u32,
/// Number of seconds to wait without _sending_ data before closing a
/// connection; disabled when `None`.
pub write_timeout: u32,
/// How much information to log.
pub log_level: LoggingLevel,
/// The secret key.
pub secret_key: Option<String>,
/// TLS configuration (path to certificates file, path to private key file).
pub tls: Option<(String, String)>,
/// Size limits.
pub limits: Limits,
/// Any extra parameters that aren't part of Rocket's config.
pub extras: HashMap<String, Value>,
/// The root directory of this config, if any.
pub root: Option<PathBuf>,
}
impl ConfigBuilder {
/// Create a new `ConfigBuilder` instance using the default parameters from
/// the given `environment`.
///
/// This method is typically called indirectly via [`Config::build()`].
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .address("127.0.0.1")
/// .port(700)
/// .workers(12)
/// .finalize();
///
/// # assert!(config.is_ok());
/// ```
pub fn new(environment: Environment) -> ConfigBuilder {
let config = Config::new(environment);
ConfigBuilder {
environment: config.environment,
address: config.address,
port: config.port,
workers: config.workers,
keep_alive: config.keep_alive.unwrap_or(0),
read_timeout: config.read_timeout.unwrap_or(0),
write_timeout: config.write_timeout.unwrap_or(0),
log_level: config.log_level,
secret_key: None,
tls: None,
limits: config.limits,
extras: config.extras,
root: None,
}
}
/// Sets the `address` in the configuration being built.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .address("127.0.0.1")
/// .unwrap();
///
/// assert_eq!(config.address.as_str(), "127.0.0.1");
/// ```
pub fn address<A: Into<String>>(mut self, address: A) -> Self {
self.address = address.into();
self
}
/// Sets the `port` in the configuration being built.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .port(1329)
/// .unwrap();
///
/// assert_eq!(config.port, 1329);
/// ```
#[inline]
pub fn port(mut self, port: u16) -> Self {
self.port = port;
self
}
/// Sets `workers` in the configuration being built.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .workers(64)
/// .unwrap();
///
/// assert_eq!(config.workers, 64);
/// ```
#[inline]
pub fn workers(mut self, workers: u16) -> Self {
self.workers = workers;
self
}
/// Sets the keep-alive timeout to `timeout` seconds. If `timeout` is `0`,
/// keep-alive is disabled.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .keep_alive(10)
/// .unwrap();
///
/// assert_eq!(config.keep_alive, Some(10));
///
/// let config = Config::build(Environment::Staging)
/// .keep_alive(0)
/// .unwrap();
///
/// assert_eq!(config.keep_alive, None);
/// ```
#[inline]
pub fn keep_alive(mut self, timeout: u32) -> Self {
self.keep_alive = timeout;
self
}
/// Sets the read timeout to `timeout` seconds. If `timeout` is `0`,
/// read timeouts are disabled.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .read_timeout(10)
/// .unwrap();
///
/// assert_eq!(config.read_timeout, Some(10));
///
/// let config = Config::build(Environment::Staging)
/// .read_timeout(0)
/// .unwrap();
///
/// assert_eq!(config.read_timeout, None);
/// ```
#[inline]
pub fn read_timeout(mut self, timeout: u32) -> Self {
self.read_timeout = timeout;
self
}
/// Sets the write timeout to `timeout` seconds. If `timeout` is `0`,
/// write timeouts are disabled.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .write_timeout(10)
/// .unwrap();
///
/// assert_eq!(config.write_timeout, Some(10));
///
/// let config = Config::build(Environment::Staging)
/// .write_timeout(0)
/// .unwrap();
///
/// assert_eq!(config.write_timeout, None);
/// ```
#[inline]
pub fn write_timeout(mut self, timeout: u32) -> Self {
self.write_timeout = timeout;
self
}
/// Sets the `log_level` in the configuration being built.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment, LoggingLevel};
///
/// let config = Config::build(Environment::Staging)
/// .log_level(LoggingLevel::Critical)
/// .unwrap();
///
/// assert_eq!(config.log_level, LoggingLevel::Critical);
/// ```
#[inline]
pub fn log_level(mut self, log_level: LoggingLevel) -> Self {
self.log_level = log_level;
self
}
/// Sets the `secret_key` in the configuration being built.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment, LoggingLevel};
///
/// let key = "8Xui8SN4mI+7egV/9dlfYYLGQJeEx4+DwmSQLwDVXJg=";
/// let mut config = Config::build(Environment::Staging)
/// .secret_key(key)
/// .unwrap();
/// ```
pub fn secret_key<K: Into<String>>(mut self, key: K) -> Self {
self.secret_key = Some(key.into());
self
}
/// Sets the `limits` in the configuration being built.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment, Limits};
///
/// let mut config = Config::build(Environment::Staging)
/// .limits(Limits::new().limit("json", 5 * (1 << 20)))
/// .unwrap();
/// ```
pub fn limits(mut self, limits: Limits) -> Self {
self.limits = limits;
self
}
/// Sets the TLS configuration in the configuration being built.
///
/// Certificates are read from `certs_path`. The certificate chain must be
/// in X.509 PEM format. The private key is read from `key_path`. The
/// private key must be an RSA key in either PKCS#1 or PKCS#8 PEM format.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let mut config = Config::build(Environment::Staging)
/// .tls("/path/to/certs.pem", "/path/to/key.pem")
/// # ; /*
/// .unwrap();
/// # */
/// ```
pub fn tls<C, K>(mut self, certs_path: C, key_path: K) -> Self
where C: Into<String>, K: Into<String>
{
self.tls = Some((certs_path.into(), key_path.into()));
self
}
/// Sets the `environment` in the configuration being built.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .environment(Environment::Production)
/// .unwrap();
///
/// assert_eq!(config.environment, Environment::Production);
/// ```
#[inline]
pub fn environment(mut self, env: Environment) -> Self {
self.environment = env;
self
}
/// Sets the `root` in the configuration being built.
///
/// # Example
///
/// ```rust
/// # use std::path::Path;
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .root("/my_app/dir")
/// .unwrap();
///
/// assert_eq!(config.root().unwrap(), Path::new("/my_app/dir"));
/// ```
pub fn root<P: AsRef<Path>>(mut self, path: P) -> Self {
self.root = Some(path.as_ref().to_path_buf());
self
}
/// Adds an extra configuration parameter with `name` and `value` to the
/// configuration being built. The value can be any type that implements
/// `Into<Value>` including `&str`, `String`, `Vec<V: Into<Value>>`,
/// `HashMap<S: Into<String>, V: Into<Value>>`, and most integer and float
/// types.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .extra("pi", 3.14)
/// .extra("custom_dir", "/a/b/c")
/// .unwrap();
///
/// assert_eq!(config.get_float("pi"), Ok(3.14));
/// assert_eq!(config.get_str("custom_dir"), Ok("/a/b/c"));
/// ```
pub fn extra<V: Into<Value>>(mut self, name: &str, value: V) -> Self {
self.extras.insert(name.into(), value.into());
self
}
/// Return the `Config` structure that was being built by this builder.
///
/// # Errors
///
/// If the address or secret key fail to parse, returns a `BadType` error.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .address("127.0.0.1")
/// .port(700)
/// .workers(12)
/// .keep_alive(0)
/// .finalize();
///
/// assert!(config.is_ok());
///
/// let config = Config::build(Environment::Staging)
/// .address("123.123.123.123.123 whoops!")
/// .finalize();
///
/// assert!(config.is_err());
/// ```
pub fn finalize(self) -> Result<Config> {
let mut config = Config::new(self.environment);
config.set_address(self.address)?;
config.set_port(self.port);
config.set_workers(self.workers);
config.set_keep_alive(self.keep_alive);
config.set_read_timeout(self.read_timeout);
config.set_write_timeout(self.write_timeout);
config.set_log_level(self.log_level);
config.set_extras(self.extras);
config.set_limits(self.limits);
if let Some(root) = self.root {
config.set_root(root);
}
if let Some((certs_path, key_path)) = self.tls {
config.set_tls(&certs_path, &key_path)?;
}
if let Some(key) = self.secret_key {
config.set_secret_key(key)?;
}
Ok(config)
}
/// Return the `Config` structure that was being built by this builder.
///
/// # Panics
///
/// Panics if the supplied address, secret key, or TLS configuration fail to
/// parse.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .address("127.0.0.1")
/// .unwrap();
///
/// assert_eq!(config.address.as_str(), "127.0.0.1");
/// ```
#[inline(always)]
pub fn unwrap(self) -> Config {
self.finalize().expect("ConfigBuilder::unwrap() failed")
}
/// Returns the `Config` structure that was being built by this builder.
///
/// # Panics
///
/// Panics if the supplied address, secret key, or TLS configuration fail to
/// parse. If a panic occurs, the error message `msg` is printed.
///
/// # Example
///
/// ```rust
/// use rocket::config::{Config, Environment};
///
/// let config = Config::build(Environment::Staging)
/// .address("127.0.0.1")
/// .expect("the configuration is bad!");
///
/// assert_eq!(config.address.as_str(), "127.0.0.1");
/// ```
#[inline(always)]
pub fn expect(self, msg: &str) -> Config {
self.finalize().expect(msg)
}
}