runique 3.0.2

A Django-inspired web framework for Rust with ORM, templates, and comprehensive security middleware
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! Definition of all type aliases: `ATera`, `ADb`, `StrMap`, `FieldsMap`, `AppResult`…
use crate::auth::session::CurrentUser;
use crate::config::app::RuniqueConfig;
use crate::context::template::AppError;
use crate::engine::RuniqueEngine;
use crate::prelude::{HostPolicy, PermissionsPolicy, SecurityPolicy};
use crate::utils::{csp_nonce::CspNonce, csrf::CsrfToken};
use std::{collections::HashMap, result::Result, sync::Arc, sync::RwLock};
use tera::Tera;
use tower_sessions::SessionManagerLayer;

// Import for new aliases
use crate::flash::FlashMessage;
use crate::forms::base::FormField;
use indexmap::IndexMap;

// ============================================================================
// ARC<T> ALIASES - THREAD-SAFE SHARED TYPES
// ============================================================================

/// Tera
pub type ATera = Arc<Tera>;
pub type OATera = Option<ATera>;

/// Database connection — see [`crate::db::ADb`]. Re-exported here so
/// existing `use runique::utils::ADb;` / `use runique::utils::aliases::ADb;`
/// import paths keep working.
pub use crate::db::ADb;

/// Security Policy CSP
pub type ASecurityCsp = Arc<SecurityPolicy>;

/// Security Policy Hosts
pub type ASecurityHosts = Arc<HostPolicy>;

/// Permissions Policy
pub type APermissionsPolicy = Arc<PermissionsPolicy>;

/// Runique Engine
pub type AEngine = Arc<RuniqueEngine>;
pub type OAEngine = Option<AEngine>;

/// Runique Config
pub type ARuniqueConfig = Arc<RuniqueConfig>;
pub type OARuniqueConfig = Option<ARuniqueConfig>;

// ============================================================================
// OPTION<T> ALIASES - OPTIONAL TYPES
// ============================================================================

/// Current User
pub type OCurrentUser = Option<CurrentUser>;

/// CSRF Token
pub type OCsrfToken = Option<CsrfToken>;

/// CSP Nonce
pub type OCspNonce = Option<CspNonce>;

// ============================================================================
// COLLECTIONS ALIASES - STANDARD COLLECTIONS
// ============================================================================
// Convention: ONE alias per concrete type (avoids repetition)
// Names describe the structure, not the specific usage

// --- Core Collections ---
/// String-to-String map (headers, form data, attributes, errors, etc.)
pub type StrMap = HashMap<String, String>;

/// String-to-Vec<String> map (raw multipart/urlencoded form data)
pub type StrVecMap = HashMap<String, Vec<String>>;

/// String-to-JSON map (serialized form data, field `extra_context`).
/// Deliberately `serde_json::Value`, not `tera::Value`: these maps are built with
/// `json!()` and reach templates through `Context::insert` (which takes `Serialize`).
/// Tera 2 passes filter/function arguments as `Kwargs`, so no alias is needed there.
pub type JsonMap = HashMap<String, serde_json::Value>;

/// Ordered form fields collection
pub type FieldsMap = IndexMap<String, Box<dyn FormField>>;

/// Flash messages list
pub type Messages = Vec<FlashMessage>;

// --- URL Registry ---
/// URL Registry (existing - kept for compatibility)
pub type ARlockmap = Arc<RwLock<HashMap<String, String>>>;

/// Pending URL registrations (name, path)
pub type PendingUrls = Vec<(String, String)>;

// ============================================================================
// SESSION ALIASES
// ============================================================================

/// Alias session
pub type Session<S> = SessionManagerLayer<S>;

// ============================================================================
// RESULT ALIASES - RETURN TYPES
// ============================================================================

/// Application Result Type
pub type AppResult<T> = Result<T, Box<AppError>>;