form.rs 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  1. use std::{any::Any, collections::HashMap, fmt::Debug};
  2. use dioxus_core::Event;
  3. pub type FormEvent = Event<FormData>;
  4. pub struct FormData {
  5. inner: Box<dyn HasFormData>,
  6. }
  7. impl<E: HasFormData> From<E> for FormData {
  8. fn from(e: E) -> Self {
  9. Self { inner: Box::new(e) }
  10. }
  11. }
  12. impl PartialEq for FormData {
  13. fn eq(&self, other: &Self) -> bool {
  14. self.value() == other.value() && self.values() == other.values()
  15. }
  16. }
  17. impl Debug for FormData {
  18. fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  19. f.debug_struct("FormEvent")
  20. .field("value", &self.value())
  21. .field("values", &self.values())
  22. .finish()
  23. }
  24. }
  25. impl FormData {
  26. /// Create a new form event
  27. pub fn new(event: impl HasFormData + 'static) -> Self {
  28. Self {
  29. inner: Box::new(event),
  30. }
  31. }
  32. /// Get the value of the form event
  33. pub fn value(&self) -> String {
  34. self.inner.value()
  35. }
  36. /// Get the values of the form event
  37. pub fn values(&self) -> HashMap<String, Vec<String>> {
  38. self.inner.values()
  39. }
  40. /// Get the files of the form event
  41. pub fn files(&self) -> Option<std::sync::Arc<dyn FileEngine>> {
  42. self.inner.files()
  43. }
  44. /// Downcast this event to a concrete event type
  45. pub fn downcast<T: 'static>(&self) -> Option<&T> {
  46. self.inner.as_any().downcast_ref::<T>()
  47. }
  48. }
  49. /// An object that has all the data for a form event
  50. pub trait HasFormData: std::any::Any {
  51. fn value(&self) -> String {
  52. Default::default()
  53. }
  54. fn values(&self) -> HashMap<String, Vec<String>> {
  55. Default::default()
  56. }
  57. fn files(&self) -> Option<std::sync::Arc<dyn FileEngine>> {
  58. None
  59. }
  60. /// return self as Any
  61. fn as_any(&self) -> &dyn std::any::Any;
  62. }
  63. #[cfg(feature = "serialize")]
  64. /// A serialized form data object
  65. #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq, Clone)]
  66. pub struct SerializedFormData {
  67. value: String,
  68. values: HashMap<String, Vec<String>>,
  69. files: Option<std::sync::Arc<SerializedFileEngine>>,
  70. }
  71. #[cfg(feature = "serialize")]
  72. impl SerializedFormData {
  73. /// Create a new serialized form data object
  74. pub fn new(
  75. value: String,
  76. values: HashMap<String, Vec<String>>,
  77. files: Option<std::sync::Arc<SerializedFileEngine>>,
  78. ) -> Self {
  79. Self {
  80. value,
  81. values,
  82. files,
  83. }
  84. }
  85. /// Create a new serialized form data object from a traditional form data object
  86. pub async fn async_from(data: &FormData) -> Self {
  87. Self {
  88. value: data.value(),
  89. values: data.values(),
  90. files: match data.files() {
  91. Some(files) => {
  92. let mut resolved_files = HashMap::new();
  93. for file in files.files() {
  94. let bytes = files.read_file(&file).await;
  95. resolved_files.insert(file, bytes.unwrap_or_default());
  96. }
  97. Some(std::sync::Arc::new(SerializedFileEngine {
  98. files: resolved_files,
  99. }))
  100. }
  101. None => None,
  102. },
  103. }
  104. }
  105. fn from_lossy(data: &FormData) -> Self {
  106. Self {
  107. value: data.value(),
  108. values: data.values(),
  109. files: None,
  110. }
  111. }
  112. }
  113. #[cfg(feature = "serialize")]
  114. impl HasFormData for SerializedFormData {
  115. fn value(&self) -> String {
  116. self.value.clone()
  117. }
  118. fn values(&self) -> HashMap<String, Vec<String>> {
  119. self.values.clone()
  120. }
  121. fn files(&self) -> Option<std::sync::Arc<dyn FileEngine>> {
  122. self.files
  123. .as_ref()
  124. .map(|files| std::sync::Arc::clone(files) as std::sync::Arc<dyn FileEngine>)
  125. }
  126. fn as_any(&self) -> &dyn std::any::Any {
  127. self
  128. }
  129. }
  130. #[cfg(feature = "serialize")]
  131. impl serde::Serialize for FormData {
  132. fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
  133. SerializedFormData::from_lossy(self).serialize(serializer)
  134. }
  135. }
  136. #[cfg(feature = "serialize")]
  137. impl<'de> serde::Deserialize<'de> for FormData {
  138. fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
  139. let data = SerializedFormData::deserialize(deserializer)?;
  140. Ok(Self {
  141. inner: Box::new(data),
  142. })
  143. }
  144. }
  145. #[cfg(feature = "serialize")]
  146. /// A file engine that serializes files to bytes
  147. #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq, Clone)]
  148. pub struct SerializedFileEngine {
  149. files: HashMap<String, Vec<u8>>,
  150. }
  151. #[cfg(feature = "serialize")]
  152. #[async_trait::async_trait(?Send)]
  153. impl FileEngine for SerializedFileEngine {
  154. fn files(&self) -> Vec<String> {
  155. self.files.keys().cloned().collect()
  156. }
  157. async fn read_file(&self, file: &str) -> Option<Vec<u8>> {
  158. self.files.get(file).cloned()
  159. }
  160. async fn read_file_to_string(&self, file: &str) -> Option<String> {
  161. self.read_file(file)
  162. .await
  163. .map(|bytes| String::from_utf8_lossy(&bytes).to_string())
  164. }
  165. async fn get_native_file(&self, file: &str) -> Option<Box<dyn Any>> {
  166. self.read_file(file)
  167. .await
  168. .map(|val| Box::new(val) as Box<dyn Any>)
  169. }
  170. }
  171. #[async_trait::async_trait(?Send)]
  172. pub trait FileEngine {
  173. // get a list of file names
  174. fn files(&self) -> Vec<String>;
  175. // read a file to bytes
  176. async fn read_file(&self, file: &str) -> Option<Vec<u8>>;
  177. // read a file to string
  178. async fn read_file_to_string(&self, file: &str) -> Option<String>;
  179. // returns a file in platform's native representation
  180. async fn get_native_file(&self, file: &str) -> Option<Box<dyn Any>>;
  181. }
  182. impl_event! {
  183. FormData;
  184. /// onchange
  185. onchange
  186. /// oninput handler
  187. oninput
  188. /// oninvalid
  189. oninvalid
  190. /// onreset
  191. onreset
  192. /// onsubmit
  193. onsubmit
  194. }