Struct AppConfig 

pub struct AppConfig {
    pub name: String,
    pub label: String,
    pub verbose_name: Option<String>,
    pub path: Option<String>,
    pub default_auto_field: Option<String>,
    pub models_ready: bool,
}

Available on crate feature core and non-WebAssembly only.

Configuration for a single application

Fields

name: String

The full Python-style name of the application (e.g., “myapp” or “myproject.apps.MyAppConfig”)

label: String

The short label for the application (e.g., “myapp”)

verbose_name: Option<String>

Human-readable name for the application

path: Option<String>

Filesystem path to the application

default_auto_field: Option<String>

Default auto field type for models in this app

models_ready: bool

Whether the app has been populated with models

Implementations

impl AppConfig

pub fn new(name: impl Into<String>, label: impl Into<String>) -> AppConfig

Create a new AppConfig with required fields

pub fn with_verbose_name(self, verbose_name: impl Into<String>) -> AppConfig

Set the verbose name for the application

pub fn with_path(self, path: impl Into<String>) -> Result<AppConfig, AppError>

Set the path for the application.

The path is validated to reject path traversal sequences (..), absolute paths (starting with / or a Windows drive letter), and null bytes. These restrictions prevent path traversal attacks when the path is later used to locate application resources on disk.

Errors

Returns AppError::ConfigError if the path contains disallowed sequences.

pub fn with_default_auto_field(self, field: impl Into<String>) -> AppConfig

Set the default auto field for the application

pub fn validate_label(&self) -> Result<(), AppError>

Validate the application label

pub fn ready(&self) -> Result<(), Box<dyn Error>>

Ready hook for the application

This method is called when the application is ready, after all configurations have been loaded and models have been registered. Override this method in custom application configurations to perform initialization tasks.

Examples

use reinhardt_apps::AppConfig;

let config = AppConfig::new("myapp", "myapp");
config.ready().expect("Ready hook should succeed");

Trait Implementations

impl Clone for AppConfig

fn clone(&self) -> AppConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppConfig

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

Formats the value using the given formatter.

impl LocaleProvider for AppConfig

fn locale_dir(&self) -> Option<PathBuf>

Get the locale directory for this app

impl MediaProvider for AppConfig

fn media_dir(&self) -> Option<PathBuf>

Get the media directory for this app

fn media_url_prefix(&self) -> Option<String>

Get the media URL prefix for this app

impl StaticFilesProvider for AppConfig

Default implementations for AppConfig

fn static_dir(&self) -> Option<PathBuf>

Get the static files directory for this app

fn static_url_prefix(&self) -> Option<String>

Get the static URL prefix for this app