actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2024-11-27 18:12:57 +01:00
Code Issues Releases Wiki Activity

Fix some typos and change wording

Browse Source
This commit is contained in:
Matthias Endler 2018-06-01 17:11:25 +02:00 committed by GitHub
parent c28b2fc492
commit b96f63841b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
content/docs/extractors.md
View File

@ -71,10 +71,10 @@ impl<S> Handler<S> for MyHandler {
be extracted from the Request's path. You can deserialize any variable be extracted from the Request's path. You can deserialize any variable
segment from the path. segment from the path.
For instance, for resource that registered for `/users/{userid}/{friend}` path For instance, for resource that registered for the `/users/{userid}/{friend}` path
two segments could be deserialized, `userid` and `friend`. This segments two segments could be deserialized, `userid` and `friend`. These segments
could be extracted to a `tuple`, i.e. `Path<(u32, String)>` or structure could be extracted into a `tuple`, i.e. `Path<(u32, String)>` or any structure
that implementd `Deserialize` trait from *serde* crate. that implements the `Deserialize` trait from the *serde* crate.
```rust ```rust
use actix_web::{App, Path, Result, http}; use actix_web::{App, Path, Result, http};
@ -93,12 +93,12 @@ fn main() {
} }
``` ```
Remember! handler function that uses extractors has to be registered with Remember! A handler function that uses extractors has to be registered using the
[*Route::with()*](../../actix-web/actix_web/dev/struct.Route.html#method.with) method. [*Route::with()*](../../actix-web/actix_web/dev/struct.Route.html#method.with) method.
It is also possible to extract path information to a specific type that It is also possible to extract path information to a specific type that
implements `Deserialize` trait from *serde*. Here is equivalent example that uses *serde* implements the `Deserialize` trait from *serde*. Here is an equivalent example that uses *serde*
instead of *tuple* type. instead of a *tuple* type.
```rust ```rust
#[macro_use] extern crate serde_derive; #[macro_use] extern crate serde_derive;
@ -125,7 +125,7 @@ fn main() {
# Query # Query
Same can be done with the request's query. Same can be done with the request's query.
[*Query*](../../actix-web/actix_web/struct.Query.html) The [*Query*](../../actix-web/actix_web/struct.Query.html)
type provides extraction functionality. Underneath it uses *serde_urlencoded* crate. type provides extraction functionality. Underneath it uses *serde_urlencoded* crate.
```rust ```rust
@ -152,7 +152,7 @@ fn main() {
# Json # Json
[*Json*](../../actix-web/actix_web/struct.Json.html) allows to deserialize [*Json*](../../actix-web/actix_web/struct.Json.html) allows to deserialize
request body to a struct. To extract typed information from request's body, a request body into a struct. To extract typed information from a request's body,
the type `T` must implement the `Deserialize` trait from *serde*. the type `T` must implement the `Deserialize` trait from *serde*.
```rust ```rust
@ -176,13 +176,13 @@ fn main() {
} }
``` ```
Some extractors provide a way to configure extraction process. Json extractor Some extractors provide a way to configure the extraction process. Json extractor
[*JsonConfig*](../../actix-web/actix_web/dev/struct.JsonConfig.html) type for configuration. [*JsonConfig*](../../actix-web/actix_web/dev/struct.JsonConfig.html) type for configuration.
When you register handler `Route::with()` returns configuration instance. In case of When you register a handler using `Route::with()`, it returns a configuration instance. In case of
*Json* extractor it returns *JsonConfig*. You can configure max size of the json a *Json* extractor it returns a *JsonConfig*. You can configure the maximum size of the json
payload and custom error handler function. payload as well as a custom error handler function.
Following example limits size of the payload to 4kb and uses custom error hander. The following example limits the size of the payload to 4kb and uses a custom error hander.
```rust ```rust
#[macro_use] extern crate serde_derive; #[macro_use] extern crate serde_derive;
@ -214,12 +214,12 @@ fn main() {
# Form # Form
At the moment only url-encoded forms are supported. Url encoded body At the moment only url-encoded forms are supported. The url-encoded body
could be extracted to a specific type. This type must implement could be extracted to a specific type. This type must implement
the `Deserialize` trait from *serde* crate. the `Deserialize` trait from the *serde* crate.
[*FormConfig*](../../actix-web/actix_web/dev/struct.FormConfig.html) allows [*FormConfig*](../../actix-web/actix_web/dev/struct.FormConfig.html) allows
to configure extraction process. configuring the extraction process.
```rust ```rust
#[macro_use] extern crate serde_derive; #[macro_use] extern crate serde_derive;
@ -231,8 +231,8 @@ struct FormData {
} }
/// extract form data using serde /// extract form data using serde
/// this handler get called only if content type is *x-www-form-urlencoded* /// this handler gets called only if the content type is *x-www-form-urlencoded*
/// and content of the request could be deserialized to a `FormData` struct /// and the content of the request could be deserialized to a `FormData` struct
fn index(form: Form<FormData>) -> Result<String> { fn index(form: Form<FormData>) -> Result<String> {
Ok(format!("Welcome {}!", form.username)) Ok(format!("Welcome {}!", form.username))
} }
@ -241,10 +241,10 @@ fn index(form: Form<FormData>) -> Result<String> {
# Multiple extractors # Multiple extractors
Actix provides extractor implementation for tuples (up to 10 elements) Actix provides extractor implementations for tuples (up to 10 elements)
which elements provide `FromRequest` impl. whose elements implement `FromRequest`.
For example we can use path extractor and query extractor at the same time. For example we can use a path extractor and a query extractor at the same time.
```rust ```rust
#[macro_use] extern crate serde_derive; #[macro_use] extern crate serde_derive;
@ -273,11 +273,11 @@ Actix also provides several other extractors:
* [*State*](../../actix-web/actix_web/struct.State.html) - If you need * [*State*](../../actix-web/actix_web/struct.State.html) - If you need
access to an application state. This is similar to a `HttpRequest::state()`. access to an application state. This is similar to a `HttpRequest::state()`.
* *HttpRequest* - *HttpRequest* itself is an extractor which returns self. * *HttpRequest* - *HttpRequest* itself is an extractor which returns self,
In case if you need access to the request. in case you need access to the request.
* *String* - You can convert request's payload to a *String*. * *String* - You can convert a request's payload to a *String*.
[*Example*](../../actix-web/actix_web/trait.FromRequest.html#example-1) [*Example*](../../actix-web/actix_web/trait.FromRequest.html#example-1)
is available in doc strings. is available in doc strings.
* *bytes::Bytes* - You can convert request's payload to a *Bytes*. * *bytes::Bytes* - You can convert a request's payload into *Bytes*.
[*Example*](../../actix-web/actix_web/trait.FromRequest.html#example) [*Example*](../../actix-web/actix_web/trait.FromRequest.html#example)
is available in doc strings. is available in doc strings.