Struct Settings 

#[non_exhaustive]
pub struct Settings {

    pub core: CoreSettings,
    pub templates: Vec<TemplateConfig>,
    pub static_url: String,
    pub static_root: Option<PathBuf>,
    pub staticfiles_dirs: Vec<PathBuf>,
    pub media_url: String,
    pub media_root: Option<PathBuf>,
    pub language_code: String,
    pub time_zone: String,
    pub use_i18n: bool,
    pub use_tz: bool,
    pub default_auto_field: String,
    pub admins: Vec<Contact>,
    pub managers: Vec<Contact>,
}

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Available on crate feature conf and non-WebAssembly only.

Main settings structure for a Reinhardt project

Deprecated since 0.2.0: Use CoreSettings fragment with ProjectSettings instead. This struct is retained as a migration bridge and implements HasCoreSettings so existing code can be gradually moved to the composable settings system.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

core: CoreSettings

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Core settings (flattened for backward-compatible TOML deserialization).

templates: Vec<TemplateConfig>

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Template engine configurations.

Note: Currently not consumed by the framework. Reserved for future template engine integration. Setting this value has no effect on framework behavior.

static_url: String

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Static files URL prefix.

static_root: Option<PathBuf>

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Static files root directory.

staticfiles_dirs: Vec<PathBuf>

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Additional static files directories (STATICFILES_DIRS).

media_url: String

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Media files URL prefix.

media_root: Option<PathBuf>

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Media files root directory.

language_code: String

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Language code for internationalization.

Note: Currently not consumed by the framework. Reserved for future i18n implementation. Setting this value has no effect on framework behavior.

time_zone: String

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Time zone for datetime handling.

Note: Currently not consumed by the framework. Reserved for future timezone support implementation. Setting this value has no effect on framework behavior.

use_i18n: bool

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Enable internationalization.

Note: Currently not consumed by the framework. Reserved for future i18n implementation. Setting this value has no effect on framework behavior.

use_tz: bool

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Use timezone-aware datetimes.

Note: Currently not consumed by the framework. Reserved for future timezone support implementation. Setting this value has no effect on framework behavior.

default_auto_field: String

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

Default auto field type for models.

Note: Currently not consumed by the framework. Reserved for future auto field configuration. Setting this value has no effect on framework behavior.

admins: Vec<Contact>

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

List of administrators who receive error notifications. Django equivalent: ADMINS = [(‘name’, ‘email’), …]

managers: Vec<Contact>

👎Deprecated since 0.2.0:

use CoreSettings fragment with ProjectSettings instead

List of managers who receive broken link notifications, etc. Django equivalent: MANAGERS = [(‘name’, ‘email’), …]

Implementations

impl Settings

pub fn new(base_dir: PathBuf, secret_key: String) -> Settings

Available on crate feature core only.

Create a new Settings instance with default values

Examples

use reinhardt_conf::settings::Settings;
use std::path::PathBuf;

#[allow(deprecated)]
let settings = Settings::new(
    PathBuf::from("/app"),
    "my-secret-key-12345".to_string()
);

assert_eq!(settings.core.base_dir, PathBuf::from("/app"));
assert_eq!(settings.core.secret_key, "my-secret-key-12345");
assert!(settings.core.debug);
assert_eq!(settings.time_zone, "UTC");
assert!(settings.core.installed_apps.is_empty());

pub fn add_app(&mut self, app: impl Into<String>)

👎Deprecated since 0.2.0:

Use installed_apps! macro with ApplicationBuilder instead

Available on crate feature core only.

Add an installed app

Deprecated since 0.2.0: Use installed_apps! macro with ApplicationBuilder instead.

Examples

use reinhardt_conf::settings::Settings;

#[allow(deprecated)]
let mut settings = Settings::default();
#[allow(deprecated)]
{
    let initial_count = settings.core.installed_apps.len();
    settings.add_app("myapp");

    assert_eq!(settings.core.installed_apps.len(), initial_count + 1);
    assert!(settings.core.installed_apps.contains(&"myapp".to_string()));
}

pub fn with_validated_apps<F>(self, app_provider: F) -> Settings

where F: FnOnce() -> Vec<String>,

👎Deprecated since 0.2.0:

Use installed_apps! macro with ApplicationBuilder instead

Available on crate feature core only.

Create settings with a compile-time validated app list

This method accepts a function that returns Vec<String> generated by the installed_apps! macro, providing compile-time validation of app names.

Deprecated since 0.2.0: Use installed_apps! macro with ApplicationBuilder instead.

Examples

use reinhardt_conf::settings::Settings;

#[allow(deprecated)]
let settings = Settings::default()
    .with_validated_apps(|| vec![
        "reinhardt.contrib.admin".to_string(),
        "myapp".to_string(),
    ]);

#[allow(deprecated)]
{
    assert_eq!(settings.core.installed_apps.len(), 2);
    assert!(settings.core.installed_apps.contains(&"myapp".to_string()));
}

pub fn add_admin(&mut self, name: impl Into<String>, email: impl Into<String>)

Available on crate feature core only.

Add an administrator

Examples

use reinhardt_conf::settings::{Settings, Contact};

#[allow(deprecated)]
let mut settings = Settings::default();
settings.add_admin("John Doe", "john@example.com");

assert_eq!(settings.admins.len(), 1);
assert_eq!(settings.admins[0].name, "John Doe");
assert_eq!(settings.admins[0].email, "john@example.com");

pub fn add_manager(&mut self, name: impl Into<String>, email: impl Into<String>)

Available on crate feature core only.

Add a manager

Examples

use reinhardt_conf::settings::{Settings, Contact};

#[allow(deprecated)]
let mut settings = Settings::default();
settings.add_manager("Jane Smith", "jane@example.com");

assert_eq!(settings.managers.len(), 1);
assert_eq!(settings.managers[0].name, "Jane Smith");
assert_eq!(settings.managers[0].email, "jane@example.com");

pub fn managers_from_admins(&mut self)

Available on crate feature core only.

Set managers to be the same as administrators

This is a common pattern in Django projects where MANAGERS = ADMINS

Examples

use reinhardt_conf::settings::Settings;

#[allow(deprecated)]
let mut settings = Settings::default();
settings.add_admin("John Doe", "john@example.com");
settings.add_admin("Jane Smith", "jane@example.com");
settings.managers_from_admins();

assert_eq!(settings.managers.len(), 2);
assert_eq!(settings.managers, settings.admins);

pub fn with_admins(self, admins: Vec<Contact>) -> Settings

Available on crate feature core only.

Set administrators with a fluent API

Examples

use reinhardt_conf::settings::{Settings, Contact};

#[allow(deprecated)]
let settings = Settings::default()
    .with_admins(vec![
        Contact::new("John Doe", "john@example.com"),
        Contact::new("Jane Smith", "jane@example.com"),
    ]);

assert_eq!(settings.admins.len(), 2);

pub fn with_managers(self, managers: Vec<Contact>) -> Settings

Available on crate feature core only.

Set managers with a fluent API

Examples

use reinhardt_conf::settings::{Settings, Contact};

#[allow(deprecated)]
let settings = Settings::default()
    .with_managers(vec![
        Contact::new("Alice Brown", "alice@example.com"),
    ]);

assert_eq!(settings.managers.len(), 1);

pub fn get_static_config(&self) -> Result<StaticFilesConfig, String>

Available on crate feature core only.

Convert Settings to StaticFilesConfig

This method extracts static files related configuration from Settings and creates a StaticFilesConfig instance suitable for use with CollectStaticCommand.

Returns

Returns Ok(StaticFilesConfig) if static_root is configured, or Err if static_root is None.

Examples

use reinhardt_conf::settings::Settings;
use std::path::PathBuf;

#[allow(deprecated)]
let settings = Settings::new(
    PathBuf::from("/app"),
    "secret".to_string()
);

let config = settings.get_static_config().unwrap();
assert_eq!(config.static_url, "/static/");

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<(), Error>

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Settings, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Settings> for SecurityConfig

fn from(settings: &Settings) -> SecurityConfig

Converts to this type from the input type.

impl HasSettings<CoreSettings> for Settings

fn get_settings(&self) -> &CoreSettings

Returns a reference to the contained fragment.

impl Serialize for Settings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.