filigree 0.4.1

Filigree web application framework
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

#![warn(missing_docs)]
//! The non-generated components of the Filigree web framework

use std::borrow::Cow;

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Authentication and Authorization
pub mod auth;
pub mod config;
/// Email templates and sending
pub mod email;
pub mod error_reporting;
pub mod error_stack;
/// Error handling
pub mod errors;
/// Request extractors
pub mod extract;
#[cfg(feature = "maud")]
pub mod html;
#[cfg(feature = "htmx")]
pub mod htmx;
/// Extension trait to inspect the body of a Reqwest error response
pub mod inspect_response;
#[cfg(feature = "maud")]
pub mod maud;
/// A UUIDv7-based type for handling object IDs with a more compact representation.
pub mod object_id;
#[cfg(feature = "tracing")]
pub mod propagate_http_span;
/// Common query string structures for use with Axum's [Query](axum::extract::Query) extractor
pub mod query_string;
pub mod requests;
/// Services that can be placed in the Axum router
pub mod route_services;
/// Utilities for running an HTTP server
pub mod server;
/// Utilities for working with SQL queries
pub mod sql;
#[cfg(feature = "storage")]
/// Cloud object storage
pub mod storage;
#[cfg(feature = "filigree-cli")]
/// Template code generation helpers for the Filigree CLI
pub mod templates;
/// Functionality to help test your app
pub mod testing;
/// Tracing configuration
#[cfg(feature = "tracing")]
pub mod tracing_config;
#[cfg(feature = "storage")]
pub mod uploads;
#[cfg(feature = "local_auth")]
/// Manage users, roles, and related data
pub mod users;
#[cfg(feature = "maud")]
pub mod vite_manifest;

/// A simple structure for sending back a message-only response
#[derive(Serialize, Debug)]
pub struct Message<'a> {
    message: Cow<'a, str>,
}

impl<'a> Message<'a> {
    /// Create a new Message with the given text.
    pub fn new(message: impl Into<Cow<'a, str>>) -> Self {
        Self {
            message: message.into(),
        }
    }
}

/// A request body that only contains an email
#[derive(Debug, Deserialize, Serialize, JsonSchema)]
pub struct EmailBody {
    /// The email address
    #[validate(email)]
    pub email: String,
}