Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msrd0/gotham_formdata
Form data parsing for the gotham web framework
https://github.com/msrd0/gotham_formdata
data form gotham html http multipart rust server urlencoded
Last synced: about 2 months ago
JSON representation
Form data parsing for the gotham web framework
- Host: GitHub
- URL: https://github.com/msrd0/gotham_formdata
- Owner: msrd0
- License: apache-2.0
- Created: 2020-10-27T20:48:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T04:43:29.000Z (7 months ago)
- Last Synced: 2024-10-11T02:32:42.985Z (2 months ago)
- Topics: data, form, gotham, html, http, multipart, rust, server, urlencoded
- Language: Rust
- Homepage:
- Size: 265 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
:warning: This crate is still alpha. APIs are subject to change. :warning:
gotham_formdata :writing_hand:
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_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, 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.
```
[body extractor]: https://github.com/gotham-rs/gotham/issues/11
[gotham]: https://github.com/gotham-rs/gotham
[multipart]: https://crates.io/crates/multipart