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
/*! This crate is an extension to the popular [gotham web framework][gotham] for Rust. It aims to reduce boilerplate necessary to read request bodies today as a stop-gap until gotham finally implements a [body extractor]. # :sparkles: Features - Parse `application/x-www-form-urlencoded` request bodies - Parse `multipart/form-data` request bodies - Verify the parsed request body - `#![forbid(unsafe_code)]` ensures that all functionality is implemented in 100% safe Rust code # :warning: Warning This crate is asynchronous, but does not yet enforce uploads limits. **YOU ARE RESPONSIBLE FOR ENFORCING UPLOAD LIMITS.** # :spiral_notepad: Example ```rust # use gotham::handler::HandlerError; # use gotham::helpers::http::response::*; # use gotham::hyper::{Body, Response, StatusCode}; # use gotham::state::State; # use mime::TEXT_PLAIN; use gotham_formdata::FormData; #[derive(FormData)] struct LoginData { #[validate(regex = "[a-zA-Z0-9_]", error = "The username contains illegal characters.")] username: String, #[validate(min_length = 6)] password: String } async fn login_handler(state: &mut State) -> Result<Response<Body>, HandlerError> { let login_data: LoginData = FormData::parse_form_data(state).await?; Ok(if login_data.password == "secret" { create_response(state, StatusCode::OK, TEXT_PLAIN, login_data.username) } else { create_empty_response(state, StatusCode::FORBIDDEN) }) } ``` # :label: Versioning Like all rust crates, this crate will follow semantic versioning guidelines. However, changing the MSRV (minimum supported rust version) is not considered a breaking change. # :page_with_curl: License ```text Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ``` [body extractor]: https://github.com/gotham-rs/gotham/issues/11 [gotham]: https://github.com/gotham-rs/gotham [multipart]: https://crates.io/crates/multipart */ #![warn(missing_docs, rust_2018_idioms)] #![deny(missing_debug_implementations, unreachable_pub)] #![forbid(unsafe_code)] #[doc(hidden)] /// Not public API. pub mod export { pub use futures_util::{future::FutureExt, stream::StreamExt}; pub use gotham::{hyper::body::Bytes, state::State}; #[cfg(feature = "regex-validation")] pub use once_cell::sync::Lazy; #[cfg(feature = "regex-validation")] pub use regex::Regex; } #[doc(inline)] pub use gotham_formdata_derive::*; pub mod conversion; mod error; pub use error::*; mod form_data; pub use form_data::*; #[doc(hidden)] /// Not public API. pub mod internal; pub mod validate; pub mod value;