1
0
mirror of https://github.com/actix/actix-website synced 2024-11-27 18:12:57 +01:00

Fix some typos/grammatical errors (#219)

This commit is contained in:
Mark Lodato 2021-03-31 09:54:44 -04:00 committed by GitHub
parent defe1142df
commit 3ed587a81a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 20 additions and 20 deletions

View File

@ -15,7 +15,7 @@ in no time.
The documentation on this website focusses primarily on the Actix Web framework. For information The documentation on this website focusses primarily on the Actix Web framework. For information
about the actor framework called Actix, check out the [Actix book][actix-book] (or the lower level about the actor framework called Actix, check out the [Actix book][actix-book] (or the lower level
[actix API docs][actix-docs]). Otherwise, head on to the [getting started guide][getting-started]. [actix API docs][actix-docs]). Otherwise, head on to the [getting started guide][getting-started].
If you already know your ways around and you need specific information you might want to read the If you already know your way around and you need specific information you might want to read the
[actix-web API docs][actix-web-docs]. [actix-web API docs][actix-web-docs].
[getting-started]: ./getting-started [getting-started]: ./getting-started

View File

@ -23,7 +23,7 @@ prefix should consist of value path segments.
{{< include-example example="application" file="app.rs" section="setup" >}} {{< include-example example="application" file="app.rs" section="setup" >}}
In this example, an application with the `/app` prefix and a `index.html` resource are created. This In this example, an application with the `/app` prefix and an `index.html` resource is created. This
resource is available through the `/app/index.html` url. resource is available through the `/app/index.html` url.
> For more information, check the [URL Dispatch][usingappprefix] section. > For more information, check the [URL Dispatch][usingappprefix] section.
@ -38,7 +38,7 @@ Let's write a simple application and store the application name in the state:
{{< include-example example="application" file="state.rs" section="setup" >}} {{< include-example example="application" file="state.rs" section="setup" >}}
and pass in the state when initializing the App, and start the application: Next, pass in the state when initializing the App and start the application:
{{< include-example example="application" file="state.rs" section="start_app" >}} {{< include-example example="application" file="state.rs" section="start_app" >}}

View File

@ -11,8 +11,8 @@ Actix-web uses its own [`actix_web::error::Error`][actixerror] type and
If a handler returns an `Error` (referring to the [general Rust trait If a handler returns an `Error` (referring to the [general Rust trait
`std::error::Error`][stderror]) in a `Result` that also implements the `ResponseError` trait, `std::error::Error`][stderror]) in a `Result` that also implements the `ResponseError` trait,
actix-web will render that error as an HTTP response with it's corresponding actix-web will render that error as an HTTP response with its corresponding
[`actix_web::http::StatusCode`][status_code]. Internal server error is generated by default: [`actix_web::http::StatusCode`][status_code]. An internal server error is generated by default:
```rust ```rust
pub trait ResponseError { pub trait ResponseError {

View File

@ -7,7 +7,7 @@ weight: 170
# Type-safe information extraction # Type-safe information extraction
Actix-web provides a facility for type-safe request information access called *extractors* Actix-web provides a facility for type-safe request information access called *extractors*
(ie, `impl FromRequest`). By default, actix-web provides several extractor implementations. (i.e., `impl FromRequest`). By default, actix-web provides several extractor implementations.
An extractor can be accessed as an argument to a handler function. Actix-web supports An extractor can be accessed as an argument to a handler function. Actix-web supports
up to 12 extractors per handler function. Argument position does not matter. up to 12 extractors per handler function. Argument position does not matter.
@ -51,10 +51,10 @@ trait from *serde*.
{{< include-example example="extractors" file="json_one.rs" section="json-one" >}} {{< include-example example="extractors" file="json_one.rs" section="json-one" >}}
Some extractors provide a way to configure the extraction process. Json extractor Some extractors provide a way to configure the extraction process. To configure
[*JsonConfig*][jsonconfig] type for configuration. To configure an extractor, pass its an extractor, pass its configuration object to the resource's `.data()` method.
configuration object to the resource's `.data()` method. In case of a *Json* extractor In the case of *Json* extractor it returns a [*JsonConfig*][jsonconfig].
it returns a *JsonConfig*. You can configure the maximum size of the json payload as You can configure the maximum size of the JSON payload as
well as a custom error handler function. well as a custom error handler function.
The following example limits the size of the payload to 4kb and uses a custom error handler. The following example limits the size of the payload to 4kb and uses a custom error handler.
@ -100,7 +100,7 @@ Here is an example of a handler that stores the number of processed requests:
{{< include-example example="request-handlers" file="main.rs" section="data" >}} {{< include-example example="request-handlers" file="main.rs" section="data" >}}
Although this handler will work, `self.0` will be different depending on the number of threads and Although this handler will work, `self.0` will be different depending on the number of threads and
number of requests processed per thread. A proper implementation would use `Arc` and `AtomicUsize`. number of requests processed per thread. A proper implementation would use `web::Data` and `AtomicUsize`.
{{< include-example example="request-handlers" file="handlers_arc.rs" section="arc" >}} {{< include-example example="request-handlers" file="handlers_arc.rs" section="arc" >}}

View File

@ -37,7 +37,7 @@ extracted from a request (see `FromRequest` trait) and returns a type that can b
Notice that some of these handlers have routing information attached directly using the built-in Notice that some of these handlers have routing information attached directly using the built-in
macros. These allow you to specify the method and path that the handler should respond to. You will macros. These allow you to specify the method and path that the handler should respond to. You will
see below how to register the other route that does not use a routing macro. see below how to register `manual_hello` (i.e. routes that do not use a routing macro).
Next, create an `App` instance and register the request handlers. Use `App::service` for the Next, create an `App` instance and register the request handlers. Use `App::service` for the
handlers using routing macros and `App::route` for manually routed handlers, declaring the path handlers using routing macros and `App::route` for manually routed handlers, declaring the path

View File

@ -7,8 +7,8 @@ weight: 160
# Request Handlers # Request Handlers
A request handler is an async function that accepts zero or more parameters that can be extracted A request handler is an async function that accepts zero or more parameters that can be extracted
from a request (ie, [*impl FromRequest*][implfromrequest]) and returns a type that can from a request (i.e., [*impl FromRequest*][implfromrequest]) and returns a type that can
be converted into an HttpResponse (ie, [*impl Responder*][respondertrait]). be converted into an HttpResponse (i.e., [*impl Responder*][respondertrait]).
Request handling happens in two stages. First the handler object is called, returning any Request handling happens in two stages. First the handler object is called, returning any
object that implements the [*Responder*][respondertrait] trait. Then, `respond_to()` is object that implements the [*Responder*][respondertrait] trait. Then, `respond_to()` is
@ -17,7 +17,7 @@ called on the returned object, converting itself to a `HttpResponse` or `Error`.
By default actix-web provides `Responder` implementations for some standard types, By default actix-web provides `Responder` implementations for some standard types,
such as `&'static str`, `String`, etc. such as `&'static str`, `String`, etc.
> For a complete list of implementations, check [*Responder documentation*][responderimpls]. > For a complete list of implementations, check the [*Responder documentation*][responderimpls].
Examples of valid handlers: Examples of valid handlers:
@ -59,7 +59,7 @@ Let's create a response for a custom type that serializes to an `application/jso
## Streaming response body ## Streaming response body
Response body can be generated asynchronously. In this case, body must implement Response body can be generated asynchronously. In this case, body must implement
the stream trait `Stream<Item=Bytes, Error=Error>`, i.e: the stream trait `Stream<Item=Bytes, Error=Error>`, i.e.:
{{< include-example example="async-handlers" file="stream.rs" section="stream" >}} {{< include-example example="async-handlers" file="stream.rs" section="stream" >}}

View File

@ -42,7 +42,7 @@ requests. Application state is not shared between the threads, and handlers are
their copy of the state with no concurrency concerns. their copy of the state with no concurrency concerns.
> Application state does not need to be `Send` or `Sync`, but application > Application state does not need to be `Send` or `Sync`, but application
factory must be `Send` + `Sync`. factories must be `Send` + `Sync`.
To share state between worker threads, use an `Arc`. Special care should be taken once sharing and To share state between worker threads, use an `Arc`. Special care should be taken once sharing and
synchronization are introduced. In many cases, performance costs are inadvertently introduced as a synchronization are introduced. In many cases, performance costs are inadvertently introduced as a

View File

@ -11,8 +11,8 @@ matching language. If one of the patterns matches the path information associate
a particular handler object is invoked. a particular handler object is invoked.
> A request handler is a function that accepts zero or more parameters that can be extracted > A request handler is a function that accepts zero or more parameters that can be extracted
> from a request (ie, [*impl FromRequest*][implfromrequest]) and returns a type that can > from a request (i.e., [*impl FromRequest*][implfromrequest]) and returns a type that can
> be converted into an HttpResponse (ie, [*impl Responder*][implresponder]). More information > be converted into an HttpResponse (i.e., [*impl Responder*][implresponder]). More information
> is available in the [handler section][handlersection]. > is available in the [handler section][handlersection].
# Resource configuration # Resource configuration

View File

@ -9,7 +9,7 @@ weight: 100
Long ago, `actix-web` was built on top of `actix`, a powerful and fast actor system. Long ago, `actix-web` was built on top of `actix`, a powerful and fast actor system.
Now, `actix-web` is largely unrelated to the actor framework and is built using a different system. Now, `actix-web` is largely unrelated to the actor framework and is built using a different system.
Though `actix` is still maintained, its usefulness as a general tool is diminishing as the Though `actix` is still maintained, its usefulness as a general tool is diminishing as the
futures and async/await ecosystem matures. At this time, the use of `actix` it is only required for futures and async/await ecosystem matures. At this time, the use of `actix` is only required for
WebSocket endpoints. WebSocket endpoints.
We call `actix-web` a powerful and pragmatic framework. For all intents and purposes it's a We call `actix-web` a powerful and pragmatic framework. For all intents and purposes it's a