stately_files/
state.rs

1//! Application state for file management handlers.
2
3use serde::{Deserialize, Serialize};
4
5use crate::settings::Dirs;
6
7/// State extracted by file handlers to access directory configuration.
8///
9/// Use with axum's `FromRef` to extract from your application state:
10///
11/// ```rust,ignore
12/// use axum::extract::FromRef;
13/// use stately_files::state::FileState;
14///
15/// #[derive(Clone)]
16/// struct AppState {
17///     dirs: Dirs,
18///     // ... other fields
19/// }
20///
21/// impl FromRef<AppState> for FileState {
22///     fn from_ref(state: &AppState) -> Self {
23///         FileState { base: Some(state.dirs.clone()) }
24///     }
25/// }
26/// ```
27#[derive(Debug, Clone, PartialEq, Hash, Serialize, Deserialize)]
28pub struct FileState {
29    /// Optional directory configuration override.
30    /// If `None`, handlers use the global [`Dirs::get()`](crate::settings::Dirs::get) defaults.
31    #[serde(skip_serializing_if = "Option::is_none")]
32    pub base: Option<Dirs>,
33}
34
35impl FileState {
36    /// Creates a new `FileState` with custom directory configuration.
37    pub fn new(dirs: Dirs) -> Self { Self { base: Some(dirs) } }
38
39    /// Creates a `FileState` that uses global defaults.
40    pub fn default_dirs() -> Self { Self { base: None } }
41}
42
43impl Default for FileState {
44    fn default() -> Self { Self::default_dirs() }
45}
stately_files/state.rs

stately_files/
state.rs
