anodyne 0.1.0

An opinionated set of tools for building applications (mostly with `axum`)
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

//! `anodyne` is an opinionated set of utilities for building web applications (mostly with `axum`).

/// Types associated with anodyne.
pub mod types {
    /// Represents the input type of a form field.
    #[derive(Default, Debug)]
    pub enum FormFieldInputType {
        #[default]
        Text,
        Password,
        Email,
        // TODO...
    }

    /// Used to build forms.
    #[derive(Debug)]
    pub struct FormFieldConfig {
        /// as in `<input name="...">`
        #[allow(unused)] // TODO
        input_name: &'static str,
        /// Defaults to a capitalized version of `FormFieldConfig::name` (with underscores turned
        /// into spaces). Can be modified with `#[field(label = "My Custom Label")]`.
        #[allow(unused)] // TODO
        label: &'static str,
        #[allow(unused)] // TODO
        input_type: FormFieldInputType,
        #[allow(unused)] // TODO
        required: bool,
    }

    impl FormFieldConfig {
        pub const fn new(
            input_name: &'static str,
            label: &'static str,
            input_type: FormFieldInputType,
            required: bool,
        ) -> Self {
            Self {
                input_name,
                label,
                input_type,
                required,
            }
        }
    }
}

pub mod traits {
    use std::collections::HashMap;

    /// Allows building and validating forms.
    ///
    /// Typically implemented with `#[derive(Form)]`.
    ///
    /// An example:
    ///
    /// ```rust
    /// use anodyne::derive::Form;
    ///
    /// #[derive(Form)]
    /// pub struct LoginForm {
    ///     #[form(
    ///         // Use range syntax to control allowable lengths
    ///         len=8..=64,
    ///         // Use regexes to constrain content
    ///         regex="^[A-Za-z0-9_-]+$",
    ///         // Provide a less nerdy error message
    ///         regex_description="must contain only alphanumeric characters and underscore/hyphen",
    ///     )]
    ///     username: String,
    ///     // Ensure fields match, override automatic label generation
    ///     #[form(len=8..=64, matches=username, label="Confirm Your Username")]
    ///     confirm_username: String,
    ///     #[form(
    ///         // Renames the field when rendered to view
    ///         name="renamed_password",
    ///         // Override field type (defaults to "text")
    ///         input_type="password", // TODO: document use of `FormFieldInputType`
    ///     )]
    ///     password: String,
    /// }
    /// ```
    pub trait Form {
        /// Returns `Ok(())` or a hashmap of input name to `Vec` of error messages for validation
        /// failures.
        fn validate(&self) -> Result<(), HashMap<&'static str, Vec<&'static str>>>;
    }
}

pub mod exports {
    pub use regex;
}

// TODO: feature 'macros'
pub mod derive {
    pub use anodyne_derive::Form;
}

// TODO: macro testing