gotham_formdata

Crates.iogotham_formdata
lib.rsgotham_formdata
version0.0.8
sourcesrc
created_at2020-11-15 19:49:53.992236
updated_at2024-03-11 22:37:25.484289
descriptionForm data parsing for the gotham web framework
homepage
repositoryhttps://github.com/msrd0/gotham_formdata
max_upload_size
id312663
size35,917
(msrd0)

documentation

README


:warning: This crate is still alpha. APIs are subject to change. :warning:

gotham_formdata :writing_hand:

crates.io docs.rs docs for main Rust 1.70+ License Apache-2.0
GitHub Actions Coverage Report dependencies

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.
Commit count: 131

cargo fmt