Struct Configuration

pub struct Configuration {
    pub metadata: Metadata,
    pub logging: Logging,
    pub core: Core,
    pub udp_trackers: Option<Vec<UdpTracker>>,
    pub http_trackers: Option<Vec<HttpTracker>>,
    pub http_api: Option<HttpApi>,
    pub health_check_api: HealthCheckApi,
}

Core configuration for the tracker.

Fields

metadata: Metadata

Configuration metadata.

logging: Logging

Logging configuration

core: Core

Core configuration.

udp_trackers: Option<Vec<UdpTracker>>

The list of UDP trackers the tracker is running. Each UDP tracker represents a UDP server that the tracker is running and it has its own configuration.

http_trackers: Option<Vec<HttpTracker>>

The list of HTTP trackers the tracker is running. Each HTTP tracker represents a HTTP server that the tracker is running and it has its own configuration.

http_api: Option<HttpApi>

The HTTP API configuration.

health_check_api: HealthCheckApi

The Health Check API configuration.

Implementations

impl Configuration

pub fn get_ext_ip(&self) -> Option<IpAddr>

Returns the tracker public IP address id defined in the configuration, and None otherwise.

pub fn create_default_configuration_file( path: &str, ) -> Result<Configuration, Error>

Saves the default configuration at the given path.

Errors

Will return Err if path is not a valid path or the configuration file cannot be created.

pub fn load(info: &Info) -> Result<Configuration, Error>

Loads the configuration from the Info struct. The whole configuration in toml format is included in the info.tracker_toml string.

Configuration provided via env var has priority over config file path.

Errors

Will return Err if the environment variable does not exist or has a bad configuration.

pub fn save_to_file(&self, path: &str) -> Result<(), Error>

Saves the configuration to the configuration file.

Errors

Will return Err if filename does not exist or the user does not have permission to read it. Will also return Err if the configuration is not valid or cannot be encoded to TOML.

Panics

Will panic if the configuration cannot be written into the file.

pub fn to_json(&self) -> String

Encodes the configuration to JSON.

Panics

Will panic if it can’t be converted to JSON.

pub fn mask_secrets(self) -> Self

Masks secrets in the configuration.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Configuration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Configuration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Configuration

fn eq(&self, other: &Configuration) -> 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 Configuration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validator for Configuration

fn validate(&self) -> Result<(), SemanticValidationError>

Errors

impl Eq for Configuration

impl StructuralPartialEq for Configuration