Struct iroh_dns_server::config::Config

pub struct Config {
    pub http: Option<HttpConfig>,
    pub https: Option<HttpsConfig>,
    pub dns: DnsConfig,
    pub metrics: Option<MetricsConfig>,
    pub mainline: Option<MainlineConfig>,
    pub pkarr_put_rate_limit: RateLimitConfig,
}

Server configuration

The config is usually loaded from a file with Self::load.

The struct also implements Default which creates a config suitable for local development and testing.

Fields

http: Option<HttpConfig>

Config for the HTTP server

If set to None no HTTP server will be started.

https: Option<HttpsConfig>

Config for the HTTPS server

If set to None no HTTPS server will be started.

dns: DnsConfig

Config for the DNS server.

metrics: Option<MetricsConfig>

Config for the metrics server.

The metrics server is started by default. To disable the metrics server, set to Some(MetricsConfig::disabled()).

mainline: Option<MainlineConfig>

Config for the mainline lookup.

pkarr_put_rate_limit: RateLimitConfig

Config for pkarr rate limit

Implementations

impl Config

pub async fn load(path: impl AsRef<Path>) -> Result<Config>

Load the config from a file.

pub fn data_dir() -> Result<PathBuf>

Get the data directory.

pub fn signed_packet_store_path() -> Result<PathBuf>

Get the path to the store database file.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.