mirror of https://github.com/fafhrd91/actix-web
intradoc conversion complete
This commit is contained in:
realaravinth
parent
c7637242db
commit
54ea1d5b33
|
|
@ -6,7 +6,7 @@
|
|||
<p>
|
||||
|
||||
[](https://crates.io/crates/actix-web)
|
||||
[](https://docs.rs/actix-web/3.3.2)
|
||||
[](actix_web)
|
||||
[](https://blog.rust-lang.org/2020/03/12/Rust-1.42.html)
|
||||
|
||||
[](https://deps.rs/crate/actix-web/3.3.2)
|
||||
|
|
@ -40,7 +40,7 @@
|
|||
|
||||
* [Website & User Guide](https://actix.rs)
|
||||
* [Examples Repository](https://github.com/actix/examples)
|
||||
* [API Documentation](https://docs.rs/actix-web)
|
||||
* [API Documentation](actix_web)
|
||||
* [API Documentation (master branch)](https://actix.rs/actix-web/actix_web)
|
||||
|
||||
## Example
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
> Static file serving for Actix Web
|
||||
|
||||
[](https://crates.io/crates/actix-files)
|
||||
[](https://docs.rs/actix-files/0.4.1)
|
||||
[](actix_files)
|
||||
[](https://blog.rust-lang.org/2020/03/12/Rust-1.42.html)
|
||||
|
||||
<br />
|
||||
|
|
@ -13,7 +13,7 @@
|
|||
|
||||
## Documentation & Resources
|
||||
|
||||
- [API Documentation](https://docs.rs/actix-files/)
|
||||
- [API Documentation](actix_files)
|
||||
- [Example Project](https://github.com/actix/examples/tree/master/static_index)
|
||||
- [Chat on Gitter](https://gitter.im/actix/actix-web)
|
||||
- Minimum supported Rust version: 1.42 or later
|
||||
|
|
|
|||
|
|
@ -3,13 +3,13 @@
|
|||
> Various helpers for Actix applications to use during testing.
|
||||
|
||||
[](https://crates.io/crates/actix-http-test)
|
||||
[](https://docs.rs/actix-http-test/2.1.0)
|
||||
[](actix_http_test)
|
||||
|
||||
[](https://deps.rs/crate/actix-http-test/2.1.0)
|
||||
[](https://gitter.im/actix/actix-web?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
## Documentation & Resources
|
||||
|
||||
- [API Documentation](https://docs.rs/actix-http-test)
|
||||
- [API Documentation](actix_http_test)
|
||||
- [Chat on Gitter](https://gitter.im/actix/actix-web)
|
||||
- Minimum Supported Rust Version (MSRV): 1.42.0
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ pub async fn test_server<F: ServiceFactory<TcpStream>>(factory: F) -> TestServer
|
|||
test_server_with_addr(tcp, factory).await
|
||||
}
|
||||
|
||||
/// Start [`test server`](./fn.test_server.html) on a concrete Address
|
||||
/// Start [`test server`](test_server()) on a concrete Address
|
||||
pub async fn test_server_with_addr<F: ServiceFactory<TcpStream>>(
|
||||
tcp: net::TcpListener,
|
||||
factory: F,
|
||||
|
|
|
|||
|
|
@ -3,14 +3,14 @@
|
|||
> HTTP primitives for the Actix ecosystem.
|
||||
|
||||
[](https://crates.io/crates/actix-http)
|
||||
[](https://docs.rs/actix-http/2.2.0)
|
||||
[](actix_http)
|
||||
|
||||
[](https://deps.rs/crate/actix-http/2.2.0)
|
||||
[](https://gitter.im/actix/actix-web?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
## Documentation & Resources
|
||||
|
||||
- [API Documentation](https://docs.rs/actix-http)
|
||||
- [API Documentation](actix_http)
|
||||
- [Chat on Gitter](https://gitter.im/actix/actix-web)
|
||||
- Minimum Supported Rust Version (MSRV): 1.42.0
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
//! ## Mime
|
||||
//!
|
||||
//! Several header fields use MIME values for their contents. Keeping with the
|
||||
//! strongly-typed theme, the [mime](https://docs.rs/mime) crate
|
||||
//! strongly-typed theme, the [mime] crate
|
||||
//! is used, such as `ContentType(pub Mime)`.
|
||||
#![cfg_attr(rustfmt, rustfmt_skip)]
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,6 @@ use http::header::{HeaderName, HeaderValue};
|
|||
///
|
||||
/// `HeaderMap` is an multi-map of [`HeaderName`] to values.
|
||||
///
|
||||
/// [`HeaderName`]: struct.HeaderName.html
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct HeaderMap {
|
||||
pub(crate) inner: FxHashMap<HeaderName, Value>,
|
||||
|
|
@ -142,7 +141,6 @@ impl HeaderMap {
|
|||
/// the values associated with the key. See [`GetAll`] for more details.
|
||||
/// Returns `None` if there are no values associated with the key.
|
||||
///
|
||||
/// [`GetAll`]: struct.GetAll.html
|
||||
pub fn get_all<N: AsName>(&self, name: N) -> GetAll<'_> {
|
||||
GetAll {
|
||||
idx: 0,
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Documentation & community resources
|
||||
|
||||
* [API Documentation](https://docs.rs/actix-multipart/)
|
||||
* [API Documentation](actix_multipart)
|
||||
* [Chat on gitter](https://gitter.im/actix/actix)
|
||||
* Cargo package: [actix-multipart](https://crates.io/crates/actix-multipart)
|
||||
* Minimum supported Rust version: 1.40 or later
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ Actix actors support for actix web framework [
|
||||
* [API Documentation](actix_web_actors)
|
||||
* [Chat on gitter](https://gitter.im/actix/actix)
|
||||
* Cargo package: [actix-web-actors](https://crates.io/crates/actix-web-actors)
|
||||
* Minimum supported Rust version: 1.40 or later
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
|
||||
## Documentation & Resources
|
||||
|
||||
- [API Documentation](https://docs.rs/actix-web-codegen)
|
||||
- [API Documentation](actix_web_codegen)
|
||||
- [Chat on Gitter](https://gitter.im/actix/actix-web)
|
||||
- Cargo package: [actix-web-codegen](https://crates.io/crates/actix-web-codegen)
|
||||
- Minimum supported Rust version: 1.42 or later.
|
||||
|
|
|
|||
|
|
@ -46,17 +46,15 @@
|
|||
//! ```
|
||||
//!
|
||||
//! [actix-web attributes docs]: https://docs.rs/actix-web/*/actix_web/#attributes
|
||||
//! [main]: attr.main.html
|
||||
//! [route]: attr.route.html
|
||||
//! [GET]: attr.get.html
|
||||
//! [POST]: attr.post.html
|
||||
//! [PUT]: attr.put.html
|
||||
//! [DELETE]: attr.delete.html
|
||||
//! [HEAD]: attr.head.html
|
||||
//! [CONNECT]: attr.connect.html
|
||||
//! [OPTIONS]: attr.options.html
|
||||
//! [TRACE]: attr.trace.html
|
||||
//! [PATCH]: attr.patch.html
|
||||
//! [GET]: get
|
||||
//! [POST]: post
|
||||
//! [PUT]: put
|
||||
//! [DELETE]: delete
|
||||
//! [HEAD]: head
|
||||
//! [CONNECT]: connect
|
||||
//! [OPTIONS]: options
|
||||
//! [TRACE]: trace
|
||||
//! [PATCH]: patch
|
||||
|
||||
#![recursion_limit = "512"]
|
||||
|
||||
|
|
|
|||
|
|
@ -3,14 +3,14 @@
|
|||
> Async HTTP and WebSocket client library.
|
||||
|
||||
[](https://crates.io/crates/awc)
|
||||
[](https://docs.rs/awc/2.0.3)
|
||||
[](awc)
|
||||
|
||||
[](https://deps.rs/crate/awc/2.0.3)
|
||||
[](https://gitter.im/actix/actix-web?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
## Documentation & Resources
|
||||
|
||||
- [API Documentation](https://docs.rs/awc)
|
||||
- [API Documentation](awc)
|
||||
- [Example Project](https://github.com/actix/examples/tree/HEAD/awc_https)
|
||||
- [Chat on Gitter](https://gitter.im/actix/actix-web)
|
||||
- Minimum Supported Rust Version (MSRV): 1.42.0
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
//! Websockets client
|
||||
//!
|
||||
//! Type definitions required to use [`awc::Client`](../struct.Client.html) as a WebSocket client.
|
||||
//! Type definitions required to use [`awc::Client`](super::Client) as a WebSocket client.
|
||||
//!
|
||||
//! # Example
|
||||
//!
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@ impl AppConfig {
|
|||
/// Server host name.
|
||||
///
|
||||
/// Host name is used by application router as a hostname for url generation.
|
||||
/// Check [ConnectionInfo](./struct.ConnectionInfo.html#method.host)
|
||||
/// Check [ConnectionInfo](ConnectionInfo::host())
|
||||
/// documentation for more information.
|
||||
///
|
||||
/// By default host name is set to a "localhost" value.
|
||||
|
|
|
|||
|
|
@ -174,7 +174,7 @@ impl ConnectionInfo {
|
|||
/// Do not use this function for security purposes, unless you can ensure the Forwarded and
|
||||
/// X-Forwarded-For headers cannot be spoofed by the client. If you want the client's socket
|
||||
/// address explicitly, use
|
||||
/// [`HttpRequest::peer_addr()`](../web/struct.HttpRequest.html#method.peer_addr) instead.
|
||||
/// [`HttpRequest::peer_addr()`](super::web::HttpRequest::peer_addr()) instead.
|
||||
#[inline]
|
||||
pub fn realip_remote_addr(&self) -> Option<&str> {
|
||||
if let Some(ref r) = self.realip_remote_addr {
|
||||
|
|
|
|||
|
|
@ -29,16 +29,16 @@
|
|||
//!
|
||||
//! To get started navigating the API docs, you may consider looking at the following pages first:
|
||||
//!
|
||||
//! * [App](struct.App.html): This struct represents an Actix web application and is used to
|
||||
//! * [App]: This struct represents an Actix web application and is used to
|
||||
//! configure routes and other common application settings.
|
||||
//!
|
||||
//! * [HttpServer](struct.HttpServer.html): This struct represents an HTTP server instance and is
|
||||
//! * [HttpServer]: This struct represents an HTTP server instance and is
|
||||
//! used to instantiate and configure servers.
|
||||
//!
|
||||
//! * [web](web/index.html): This module provides essential types for route registration as well as
|
||||
//! * [web]: This module provides essential types for route registration as well as
|
||||
//! common utilities for request handlers.
|
||||
//!
|
||||
//! * [HttpRequest](struct.HttpRequest.html) and [HttpResponse](struct.HttpResponse.html): These
|
||||
//! * [HttpRequest] and [HttpResponse]: These
|
||||
//! structs represent HTTP requests and responses and expose methods for creating, inspecting,
|
||||
//! and otherwise utilizing them.
|
||||
//!
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ use crate::HttpResponse;
|
|||
///
|
||||
/// # Security
|
||||
/// **\*** It is calculated using
|
||||
/// [`ConnectionInfo::realip_remote_addr()`](../dev/struct.ConnectionInfo.html#method.realip_remote_addr)
|
||||
/// [`ConnectionInfo::realip_remote_addr()`](super::dev::ConnectionInfo::realip_remote_addr())
|
||||
///
|
||||
/// If you use this value ensure that all requests come from trusted hosts, since it is trivial
|
||||
/// for the remote client to simulate being another client.
|
||||
|
|
|
|||
|
|
@ -213,7 +213,7 @@ where
|
|||
/// Set server host name.
|
||||
///
|
||||
/// Host name is used by application router as a hostname for url generation.
|
||||
/// Check [ConnectionInfo](./dev/struct.ConnectionInfo.html#method.host)
|
||||
/// Check [ConnectionInfo](dev::ConnectionInfo::host())
|
||||
/// documentation for more information.
|
||||
///
|
||||
/// By default host name is set to a "localhost" value.
|
||||
|
|
|
|||
|
|
@ -195,13 +195,13 @@ impl ServiceRequest {
|
|||
self.0.match_info()
|
||||
}
|
||||
|
||||
/// Counterpart to [`HttpRequest::match_name`](../struct.HttpRequest.html#method.match_name).
|
||||
/// Counterpart to [`HttpRequest::match_name`](super::HttpRequest::match_name()).
|
||||
#[inline]
|
||||
pub fn match_name(&self) -> Option<&str> {
|
||||
self.0.match_name()
|
||||
}
|
||||
|
||||
/// Counterpart to [`HttpRequest::match_pattern`](../struct.HttpRequest.html#method.match_pattern).
|
||||
/// Counterpart to [`HttpRequest::match_pattern`](super::HttpRequest::match_pattern()).
|
||||
#[inline]
|
||||
pub fn match_pattern(&self) -> Option<String> {
|
||||
self.0.match_pattern()
|
||||
|
|
@ -225,7 +225,7 @@ impl ServiceRequest {
|
|||
self.0.app_config()
|
||||
}
|
||||
|
||||
/// Counterpart to [`HttpRequest::app_data`](../struct.HttpRequest.html#method.app_data).
|
||||
/// Counterpart to [`HttpRequest::app_data`](super::HttpRequest::app_data()).
|
||||
pub fn app_data<T: 'static>(&self) -> Option<&T> {
|
||||
for container in (self.0).0.app_data.iter().rev() {
|
||||
if let Some(data) = container.get::<T>() {
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ use crate::{responder::Responder, web};
|
|||
/// To extract typed information from request's body, the type `T` must
|
||||
/// implement the `Deserialize` trait from *serde*.
|
||||
///
|
||||
/// [**FormConfig**](struct.FormConfig.html) allows to configure extraction
|
||||
/// [**FormConfig**](FormConfig) allows to configure extraction
|
||||
/// process.
|
||||
///
|
||||
/// ### Example
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ use crate::{responder::Responder, web};
|
|||
/// To extract typed information from request's body, the type `T` must
|
||||
/// implement the `Deserialize` trait from *serde*.
|
||||
///
|
||||
/// [**JsonConfig**](struct.JsonConfig.html) allows to configure extraction
|
||||
/// [**JsonConfig**](JsonConfig) allows to configure extraction
|
||||
/// process.
|
||||
///
|
||||
/// ## Example
|
||||
|
|
@ -142,7 +142,7 @@ impl<T: Serialize> Responder for Json<T> {
|
|||
/// To extract typed information from request's body, the type `T` must
|
||||
/// implement the `Deserialize` trait from *serde*.
|
||||
///
|
||||
/// [**JsonConfig**](struct.JsonConfig.html) allows to configure extraction
|
||||
/// [**JsonConfig**](JsonConfig) allows to configure extraction
|
||||
/// process.
|
||||
///
|
||||
/// ## Example
|
||||
|
|
@ -306,7 +306,7 @@ impl Default for JsonConfig {
|
|||
/// Returns error:
|
||||
///
|
||||
/// * content type is not `application/json`
|
||||
/// (unless specified in [`JsonConfig`](struct.JsonConfig.html))
|
||||
/// (unless specified in [`JsonConfig`])
|
||||
/// * content length is greater than 256k
|
||||
pub struct JsonBody<U> {
|
||||
limit: usize,
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ use crate::FromRequest;
|
|||
#[derive(PartialEq, Eq, PartialOrd, Ord)]
|
||||
/// Extract typed information from the request's path.
|
||||
///
|
||||
/// [**PathConfig**](struct.PathConfig.html) allows to configure extraction process.
|
||||
/// [**PathConfig**](PathConfig) allows to configure extraction process.
|
||||
///
|
||||
/// ## Example
|
||||
///
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ impl FromRequest for Payload {
|
|||
///
|
||||
/// Loads request's payload and construct Bytes instance.
|
||||
///
|
||||
/// [**PayloadConfig**](struct.PayloadConfig.html) allows to configure
|
||||
/// [**PayloadConfig**](PayloadConfig) allows to configure
|
||||
/// extraction process.
|
||||
///
|
||||
/// ## Example
|
||||
|
|
@ -159,7 +159,7 @@ impl FromRequest for Bytes {
|
|||
///
|
||||
/// Text extractor automatically decode body according to the request's charset.
|
||||
///
|
||||
/// [**PayloadConfig**](struct.PayloadConfig.html) allows to configure
|
||||
/// [**PayloadConfig**](PayloadConfig) allows to configure
|
||||
/// extraction process.
|
||||
///
|
||||
/// ## Example
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ use crate::request::HttpRequest;
|
|||
/// be decoded into any type which depends upon data ordering e.g. tuples or tuple-structs.
|
||||
/// Attempts to do so will *fail at runtime*.
|
||||
///
|
||||
/// [**QueryConfig**](struct.QueryConfig.html) allows to configure extraction process.
|
||||
/// [**QueryConfig**](QueryConfig) allows to configure extraction process.
|
||||
///
|
||||
/// ## Example
|
||||
///
|
||||
|
|
|
|||
Loading…
Reference in New Issue