Struct lemmy_utils::settings::structs::Settings

pub struct Settings {

    pub database: DatabaseConfig,
    pub rate_limit: Option<RateLimitConfig>,
    pub federation: FederationConfig,
    pub captcha: CaptchaConfig,
    pub email: Option<EmailConfig>,
    pub setup: Option<SetupConfig>,
    pub hostname: String,
    pub bind: IpAddr,
    pub port: u16,
    pub tls_enabled: bool,
    pub pictrs_url: Option<String>,
    pub additional_slurs: Option<String>,
    pub actor_name_max_length: usize,
    pub webfinger_community_regex: Option<Regex>,
    pub webfinger_username_regex: Option<Regex>,
}

Fields

database: DatabaseConfig

rate_limit: Option<RateLimitConfig>

federation: FederationConfig

captcha: CaptchaConfig

email: Option<EmailConfig>

setup: Option<SetupConfig>

hostname: String

bind: IpAddr

port: u16

tls_enabled: bool

pictrs_url: Option<String>

additional_slurs: Option<String>

actor_name_max_length: usize

webfinger_community_regex: Option<Regex>

webfinger_username_regex: Option<Regex>

Implementations

impl Settings

pub fn init() -> Result<Self, LemmyError>

Reads config from configuration file.

Note: The env var LEMMY_DATABASE_URL is parsed in lemmy_db_queries/src/lib.rs::get_database_url_from_env() Warning: Only call this once.

pub fn get() -> Self

Returns the config as a struct.

pub fn get_database_url(&self) -> String

pub fn get_config_location() -> String

pub fn read_config_file() -> Result<String, Error>

pub fn get_protocol_string(&self) -> &'static str

Returns either “http” or “https”, depending on tls_enabled setting

pub fn get_protocol_and_hostname(&self) -> String

Returns something like http://localhost or https://lemmy.ml, with the correct protocol and hostname.

pub fn get_hostname_without_port(&self) -> Result<String, Error>

When running the federation test setup in api_tests/ or docker/federation, the hostname variable will be like lemmy-alpha:8541. This method removes the port and returns lemmy-alpha instead. It has no effect in production.

pub fn save_config_file(data: &str) -> Result<String, LemmyError>

pub fn webfinger_community_regex(&self) -> Regex

pub fn webfinger_username_regex(&self) -> Regex

pub fn slur_regex(&self) -> Regex

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy 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() -> Self

Return Settings { database: Default::default(), rate_limit: Some(RateLimitConfig :: default()), federation: FederationConfig :: default(), captcha: CaptchaConfig :: default(), email: None, setup: None, hostname: ("unset").into(), bind: IpAddr :: V4(Ipv4Addr :: new(0, 0, 0, 0)), port: 8536, tls_enabled: true, pictrs_url: None, additional_slurs: None, actor_name_max_length: 20, webfinger_community_regex: None, webfinger_username_regex: None }

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.