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
  • #![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

use gotham_formdata::FormData;
use validator::Validate;

#[derive(FormData, Validate)]
struct LoginData {
	#[validate(length(min = 5, max = 16))]
	username: String,
	#[validate(length(min = 8))]
	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§

  • value
    This mod defines the Value used for parsing the form data.

Enums§

  • Error
    This error type is used when parsing form data from a request body was unsuccessful.

Traits§

  • FormData
    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.
  • FormDataFromState
    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 Aliases§

Derive Macros§

  • FormData
    This derive macro implements FormData for the struct it is invoked on. Enums, unions and tuple structs are not supported.