Struct Config

pub struct Config {
    inner: RwLock<ConfigInner>,
    file: Option<PathBuf>,
}

Global configuration for the links redirector server. This is the more idiomatic, easier to use (in rust code), and shareable-across-threads version, which can be updated from a Partial.

Fields

inner: RwLock<ConfigInner>

file: Option<PathBuf>

Implementations

impl Config

pub fn new(file: Option<PathBuf>) -> Self

Create a new Config instance using the provided file path as the configuration file. Configuration data is parsed from environment variables, the config file, and command-line arguments, in that order. If there is an error with the configuration file or any other configuration source, no error is emitted. Instead, a warning is logged, and the other configuration sources are used.

IO

This function performs synchronous file IO, and should therefore not be used inside of an asynchronous context.

pub fn new_static(file: Option<PathBuf>) -> &'static Self

Create a new static reference to a new Config instance using the provided file path as the configuration file. Configuration data is parsed from environment variables, the config file, and command-line arguments, in that order. If there is an error with the configuration file or any other configuration source, no error is emitted. Instead, a warning is logged, and the other configuration sources are used.

Memory

Because this function leaks memory with no (safe) way of freeing it, care should be taken not to call this function an unbounded number of times.

IO

This function performs synchronous file IO, and should therefore not be used inside of an asynchronous context.

pub fn update(&self)

Update this config from environment variables, config file, and command-line arguments. This function starts with defaults for each option, then updates those from environment variables, then from the config file, then from command-line arguments, and finally overwrites this Config’s options with those newly-parsed ones.

IO

This function performs synchronous file IO, and should therefore not be used inside of an asynchronous context.

pub fn redirector(&self) -> Redirector

Generate a redirector configuration from the options defined in this global links config.

pub fn log_level(&self) -> LogLevel

Get the configured log level

pub fn token(&self) -> Arc<str>

Get the RPC API token

pub fn listeners(&self) -> Vec<ListenAddress>

Get the list of listener addresses

pub fn statistics(&self) -> StatisticCategories

Get the types of statistics to collect

pub fn default_certificate(&self) -> DefaultCertificateSource

Get the default TLS certificate source

pub fn certificates(&self) -> Vec<CertificateSource>

Get the TLS certificate configuration

pub fn hsts(&self) -> Hsts

Get the hsts configuration option

pub fn https_redirect(&self) -> bool

Get the https_redirect configuration option

pub fn send_alt_svc(&self) -> bool

Get the send_alt_svc configuration option

pub fn send_server(&self) -> bool

Get the send_server configuration option

pub fn send_csp(&self) -> bool

Get the send_csp configuration option

pub fn store(&self) -> BackendType

Get the store type

pub fn store_config(&self) -> HashMap<String, String>

Get the store backend configuration

pub const fn file(&self) -> &Option<PathBuf>

Get the configuration file path

Trait Implementations

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Config

fn fmt(&self, fmt: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.