Crate gotham_formdata
source · [−]Expand description
This crate is an extension to the popular gotham web framework 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
:warning: Warning
This crate is synchronous. It loads the entire request body into memory. YOU ARE RESPONSIBLE FOR ENFORCING UPLOAD LIMITS. For this reason, file uploads are not supported, and this won’t change before this crate switches to an async multipart parser.
:spiral_notepad: Example
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
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.
Modules
Enums
This error type is used when parsing form data from a request body was unsuccessful.
Traits
This is the trait implemented by #[derive(FormData)]
. It provides a method to parse the struct
it is implemented for to be parsed from the request body contained in gotham’s state.
This is the equivalent of FormData from the state’s perspective. Use this if you prefer
state.parse_form_data::<MyData>()?
over MyData::parse_form_data(&mut state)?
.
Type Definitions
This is the return type of FormData::parse_form_data.
Derive Macros
This derive macro implements FormData
for the struct it is invoked on. Enums, unions and
tuple structs are not supported.