applin 0.3.0

Backend library for the Applin™ Server-Driven UI 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use crate::option::{Allow, AutoCapitalize};
use serde::{Deserialize, Serialize};
use std::time::Duration;

#[derive(Clone, Debug, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub struct Textfield {
    #[serde(default, skip_serializing_if = "crate::is_default")]
    pub allow: Allow,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub auto_capitalize: Option<AutoCapitalize>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub error: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub id: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub initial_string: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub label: String,
    #[serde(default, skip_serializing_if = "crate::is_default")]
    pub max_chars: u32,
    #[serde(default, skip_serializing_if = "crate::is_default")]
    pub max_lines: u32,
    #[serde(default, skip_serializing_if = "crate::is_default")]
    pub min_chars: u32,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub poll_delay_ms: Option<u32>,
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub validated: bool,
    pub var_name: String,
}

impl Textfield {
    /// # Panics
    /// Panics when `var_name` is empty.
    #[must_use]
    pub fn new(var_name: impl Into<String>) -> Self {
        let var_name = var_name.into();
        assert!(!var_name.is_empty());
        Self {
            allow: Allow::All,
            auto_capitalize: None,
            error: String::new(),
            id: String::new(),
            initial_string: String::new(),
            label: String::new(),
            max_chars: u32::MAX,
            max_lines: u32::MAX,
            min_chars: 0,
            poll_delay_ms: None,
            validated: false,
            var_name,
        }
    }

    #[must_use]
    pub fn with_allow(mut self, x: Allow) -> Self {
        self.allow = x;
        self
    }

    #[must_use]
    pub fn with_auto_capitalize(mut self, x: AutoCapitalize) -> Self {
        self.auto_capitalize = Some(x);
        self
    }

    #[must_use]
    pub fn with_error(mut self, x: impl Into<String>) -> Self {
        self.error = x.into();
        self
    }

    #[must_use]
    pub fn with_opt_error(mut self, x: Option<impl Into<String>>) -> Self {
        self.error = x.map_or(String::new(), Into::into);
        self
    }

    #[must_use]
    pub fn with_id(mut self, id: impl AsRef<str>) -> Self {
        self.id = id.as_ref().to_string();
        self
    }

    #[must_use]
    pub fn with_initial_string(mut self, x: impl Into<String>) -> Self {
        self.initial_string = x.into();
        self
    }

    #[must_use]
    pub fn with_opt_initial(mut self, opt_initial: Option<impl Into<String>>) -> Self {
        self.initial_string = opt_initial.map_or(String::new(), Into::into);
        self
    }

    #[must_use]
    pub fn with_label(mut self, label: impl Into<String>) -> Self {
        self.label = label.into();
        self
    }

    /// Ask the client to prevent the user from entering too many characters.
    /// Use `0` for no limit.
    #[must_use]
    pub fn with_max_chars(mut self, x: u32) -> Self {
        self.max_chars = x;
        self
    }

    /// Ask the client to prevent the user from entering too many newline characters.
    /// Use `0` for no limit.
    #[must_use]
    pub fn with_max_lines(mut self, x: u32) -> Self {
        self.max_lines = x;
        self
    }

    /// Show a warning when the user has not entered enough characters.
    /// Use 0 for no minimum.
    #[must_use]
    pub fn with_min_chars(mut self, x: u32) -> Self {
        self.min_chars = x;
        self
    }

    /// Poll the page after the field is updated and `duration` has passed.
    #[must_use]
    pub fn with_poll_delay(mut self, duration: Duration) -> Self {
        self.poll_delay_ms = Some(duration.as_millis().try_into().unwrap_or(u32::MAX));
        self
    }

    #[must_use]
    pub fn with_validated(mut self) -> Self {
        self.validated = true;
        self
    }
}

/// # Panics
/// Panics when `var_name` is empty.
#[must_use]
pub fn textfield(var_name: impl Into<String>) -> Textfield {
    Textfield::new(var_name)
}