Struct Settings 

pub struct Settings {

    pub scheme: String,
    pub host: String,
    pub port: u16,
    pub endpoint_url: String,
    pub db_dsn: Option<String>,
    pub db_settings: String,
    pub router_table_name: String,
    pub message_table_name: String,
    pub tracking_keys: String,
    pub max_data_bytes: usize,
    pub crypto_keys: String,
    pub auth_keys: String,
    pub human_logs: bool,
    pub connection_timeout_millis: u64,
    pub request_timeout_millis: u64,
    pub pool_max_idle_per_host: usize,
    pub pool_idle_timeout_secs: u64,
    pub statsd_host: Option<String>,
    pub statsd_port: u16,
    pub statsd_label: String,
    pub disable_sentry: bool,
    pub fcm: FcmSettings,
    pub apns: ApnsSettings,
    pub stub: StubSettings,
    pub reliability_dsn: Option<String>,
    pub reliability_retry_count: usize,
    pub max_notification_ttl: Duration,
}

Fields

scheme: String

Endpoint URL scheme

host: String

Endpoint URL host

port: u16

Endpoint URL port

endpoint_url: String

Endpoint URL. If this is set, it will override the scheme, host, and port settings.

db_dsn: Option<String>

The DSN to connect to the storage engine (Used to select between storage systems)

db_settings: String

JSON set of specific database settings (See data storage engines)

router_table_name: String

The router table name to use in the database (legacy, will be removed in the future)

message_table_name: String

The message table name to use in the database (legacy, will be removed in the future)

tracking_keys: String

A stringified JSON list of VAPID public keys which should be tracked internally. This should ONLY include Mozilla generated and consumed messages (e.g. “SendToTab”, etc.) These keys should be specified in stripped, b64encoded, X962 format (e.g. a single line of base64 encoded data without padding). You can use scripts/convert_pem_to_x962.py to easily convert EC Public keys stored in PEM format into appropriate x962 format.

max_data_bytes: usize

The max size of notification data in bytes.

crypto_keys: String

The cryptographic keys to use to encode the endpoint URL. NOTE: this must match the keys specified for autoconnect.

auth_keys: String

The key to use to generate the client Auth token for channel management endpoints.

human_logs: bool

Whether to include human readable logs in the output.

connection_timeout_millis: u64

Bridge connection timeout in milliseconds.

request_timeout_millis: u64

Bridge request timeout in milliseconds.

pool_max_idle_per_host: usize

Maximum idle connections per host in the HTTP connection pool.

pool_idle_timeout_secs: u64

Idle connection timeout in seconds.

statsd_host: Option<String>

The host for the statsd server to send metrics to. If None, metrics will not be sent.

statsd_port: u16

The port for the statsd server to send metrics to.

statsd_label: String

The label to use for statsd metrics.

disable_sentry: bool

Do not report errors to sentry, instead log them to STDERR.

fcm: FcmSettings

FCM bridge settings

apns: ApnsSettings

APNS bridge settings

stub: StubSettings

“Stub” is a predictable Mock bridge that allows us to “send” data and return an expected result.

reliability_dsn: Option<String>

The DNS for the reliability data store. This is normally a Redis compatible storage system. See Connection Parameters for details.

reliability_retry_count: usize

Max number of retries reliability transactions into Redis

max_notification_ttl: Duration

Max Notification Lifespan

Implementations

impl Settings

pub fn with_env_and_config_file( filename: &Option<String>, ) -> Result<Self, ConfigError>

Load the settings from the config file if supplied, then the environment.

fn read_list_from_str<'list>( list_str: &'list str, panic_msg: &'static str, ) -> impl Iterator<Item = &'list str>

Convert a string like [item1,item2] into a iterator over item1 and item2. Panics with a custom message if the string is not in the expected form.

pub fn make_fernet(&self) -> MultiFernet

Initialize the fernet encryption instance

pub fn auth_keys(&self) -> Vec<String>

Get the list of auth hash keys

pub fn tracking_keys(&self) -> Result<Vec<Vec<u8>>, ConfigError>

Get the list of tracking public keys converted to raw, x962 format byte arrays. (This avoids problems with formatting, padding, and other concerns. x962 precedes the EC key pair with a \04 byte. We’ll keep that value in place for now, since the value we are comparing against will also have the same prefix.)

pub fn endpoint_url(&self) -> Url

Get the URL for this endpoint server

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Settings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

where Settings: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.