Struct Partial

pub struct Partial {

    pub log_level: Option<LogLevel>,
    pub token: Option<String>,
    pub listeners: Option<Vec<ListenAddress>>,
    pub statistics: Option<StatisticCategories>,
    pub default_certificate: Option<DefaultCertificateSource>,
    pub certificates: Option<Vec<CertificateSource>>,
    pub hsts: Option<PartialHsts>,
    pub hsts_max_age: Option<u32>,
    pub https_redirect: Option<bool>,
    pub send_alt_svc: Option<bool>,
    pub send_server: Option<bool>,
    pub send_csp: Option<bool>,
    pub store: Option<BackendType>,
    pub store_config: Option<HashMap<String, String>>,
}

Links redirector configuration as seen from the user’s perspective.

This is easier to parse, but less idiomatic and not as easy to use as Config. As this is a representation of links’ configuration from one source only, all fields are optional, which allows incremental updates to the actual Config struct.

Fields

log_level: Option<LogLevel>

Minimum level of logs to be collected/displayed. Debug and trace levels may expose secret information, so are not recommended for production deployments.

token: Option<String>

API token, used for authentication of gRPC clients

listeners: Option<Vec<ListenAddress>>

Listener addresses, see ListenAddress for details

statistics: Option<StatisticCategories>

What types of statistics should be collected

default_certificate: Option<DefaultCertificateSource>

Default TLS certificate and key source

certificates: Option<Vec<CertificateSource>>

TLS certificate and key sources

hsts: Option<PartialHsts>

HTTP Strict Transport Security setting on redirect

hsts_max_age: Option<u32>

HTTP Strict Transport Security max_age header attribute (retention time in seconds)

https_redirect: Option<bool>

Redirect from HTTP to HTTPS before the external redirect

send_alt_svc: Option<bool>

Send the Alt-Svc header advertising h2 (HTTP/2.0 with TLS) support on port 443

send_server: Option<bool>

Send the Server header

send_csp: Option<bool>

Send the Content-Security-Policy header

store: Option<BackendType>

The store backend type

store_config: Option<HashMap<String, String>>

The store backend configuration. All of these options are backend-specific, and have ASCII alphanumeric string keys in snake_case (lower case, words seperated by underscores), without any hyphens (-), i.e. only lowercase a-z, 0-9, and _ are allowed. The values are UTF-8 strings in any format.

Implementations

impl Partial

pub fn from_toml(toml: &str) -> Result<Self, IntoPartialError>

Parse a Partial from a toml string

Errors

Returns a FromFileError::Toml if deserialization fails.

pub fn from_yaml(yaml: &str) -> Result<Self, IntoPartialError>

Parse a Partial from a yaml string

Errors

Returns a FromFileError::Yaml if deserialization fails.

pub fn from_json(json: &str) -> Result<Self, IntoPartialError>

Parse a Partial from a json string

Errors

Returns a FromFileError::Json if deserialization fails.

pub fn from_file(path: &Path) -> Result<Self, IntoPartialError>

Read and parse a configuration file into a Partial. The format of the file is determined from its extension:

• *.toml files are parsed as toml
• *.yaml and *.yml files are parsed as yaml
• *.json files are parsed as json

IO

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

Errors

Returns an error when reading of parsing the file fails.

pub fn from_args() -> Self

Parse command-line arguments into a Partial. Listeners and store configuration are parsed from json strings.

pub fn from_env_vars() -> Self

Parse environment variables with the prefix LINKS_ into a Partial. Listeners and store configuration are parsed from json strings.

pub fn hsts(&self) -> Option<Hsts>

Get HSTS configuration information from this partial config, if present

Trait Implementations

impl Clone for Partial

fn clone(&self) -> Partial

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Partial

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

Formats the value using the given formatter.

impl Default for Partial

fn default() -> Partial

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Partial

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Partial

fn eq(&self, other: &Partial) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Partial

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Partial

impl StructuralPartialEq for Partial