1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-12-18 01:43:58 +01:00

convert all remaining IETF RFC links to new format

This commit is contained in:
Rob Ede 2021-12-02 03:45:04 +00:00
parent 0df275c478
commit c4b20df56a
No known key found for this signature in database
GPG Key ID: 97C636207D3EF933
17 changed files with 35 additions and 32 deletions

View File

@ -174,7 +174,7 @@ pub(crate) trait MessageType: Sized {
self.set_expect() self.set_expect()
} }
// https://tools.ietf.org/html/rfc7230#section-3.3.3 // https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.3
if chunked { if chunked {
// Chunked encoding // Chunked encoding
Ok(PayloadLength::Payload(PayloadType::Payload( Ok(PayloadLength::Payload(PayloadType::Payload(

View File

@ -71,15 +71,16 @@ pub(crate) trait MessageType: Sized {
| StatusCode::PROCESSING | StatusCode::PROCESSING
| StatusCode::NO_CONTENT => { | StatusCode::NO_CONTENT => {
// skip content-length and transfer-encoding headers // skip content-length and transfer-encoding headers
// see https://tools.ietf.org/html/rfc7230#section-3.3.1 // see https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.1
// and https://tools.ietf.org/html/rfc7230#section-3.3.2 // and https://datatracker.ietf.org/doc/html/rfc7230#section-3.3.2
skip_len = true; skip_len = true;
length = BodySize::None length = BodySize::None
} }
StatusCode::NOT_MODIFIED => { StatusCode::NOT_MODIFIED => {
// 304 responses should never have a body but should retain a manually set // 304 responses should never have a body but should retain a manually set
// content-length header see https://tools.ietf.org/html/rfc7232#section-4.1 // content-length header
// see https://datatracker.ietf.org/doc/html/rfc7232#section-4.1
skip_len = false; skip_len = false;
length = BodySize::None; length = BodySize::None;
} }

View File

@ -304,7 +304,7 @@ fn prepare_response(
for (key, value) in head.headers.iter() { for (key, value) in head.headers.iter() {
match *key { match *key {
// TODO: consider skipping other headers according to: // TODO: consider skipping other headers according to:
// https://tools.ietf.org/html/rfc7540#section-8.1.2.2 // https://datatracker.ietf.org/doc/html/rfc7540#section-8.1.2.2
// omit HTTP/1.x only headers // omit HTTP/1.x only headers
CONNECTION | TRANSFER_ENCODING => continue, CONNECTION | TRANSFER_ENCODING => continue,
CONTENT_LENGTH if skip_len => continue, CONTENT_LENGTH if skip_len => continue,

View File

@ -66,7 +66,7 @@ impl From<http::HeaderMap> for HeaderMap {
} }
/// This encode set is used for HTTP header values and is defined at /// This encode set is used for HTTP header values and is defined at
/// <https://tools.ietf.org/html/rfc5987#section-3.2>. /// <https://datatracker.ietf.org/doc/html/rfc5987#section-3.2>.
pub(crate) const HTTP_VALUE: &AsciiSet = &CONTROLS pub(crate) const HTTP_VALUE: &AsciiSet = &CONTROLS
.add(b' ') .add(b' ')
.add(b'"') .add(b'"')

View File

@ -1,17 +1,17 @@
// Originally from hyper v0.11.27 src/header/parsing.rs
use std::{fmt, str::FromStr}; use std::{fmt, str::FromStr};
use language_tags::LanguageTag; use language_tags::LanguageTag;
use crate::header::{Charset, HTTP_VALUE}; use crate::header::{Charset, HTTP_VALUE};
// From hyper v0.11.27 src/header/parsing.rs
/// The value part of an extended parameter consisting of three parts: /// The value part of an extended parameter consisting of three parts:
/// - The REQUIRED character set name (`charset`). /// - The REQUIRED character set name (`charset`).
/// - The OPTIONAL language information (`language_tag`). /// - The OPTIONAL language information (`language_tag`).
/// - A character sequence representing the actual value (`value`), separated by single quotes. /// - A character sequence representing the actual value (`value`), separated by single quotes.
/// ///
/// It is defined in [RFC 5987](https://tools.ietf.org/html/rfc5987#section-3.2). /// It is defined in [RFC 5987 §3.2](https://datatracker.ietf.org/doc/html/rfc5987#section-3.2).
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
pub struct ExtendedValue { pub struct ExtendedValue {
/// The character set that is used to encode the `value` to a string. /// The character set that is used to encode the `value` to a string.

View File

@ -26,8 +26,8 @@ const MAX_FLOAT_QUALITY: f32 = 1.0;
/// a value between 0 and 1000 e.g. `Quality(532)` matches the quality /// a value between 0 and 1000 e.g. `Quality(532)` matches the quality
/// `q=0.532`. /// `q=0.532`.
/// ///
/// [RFC7231 Section 5.3.1](https://tools.ietf.org/html/rfc7231#section-5.3.1) /// [RFC 7231 §5.3.1](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.1) gives more
/// gives more information on quality values in HTTP header fields. /// information on quality values in HTTP header fields.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct Quality(u16); pub struct Quality(u16);
@ -79,8 +79,8 @@ impl TryFrom<f32> for Quality {
} }
} }
/// Represents an item with a quality value as defined in /// Represents an item with a quality value as defined
/// [RFC7231](https://tools.ietf.org/html/rfc7231#section-5.3.1). /// in [RFC 7231 §5.3.1](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.1).
#[derive(Clone, PartialEq, Debug)] #[derive(Clone, PartialEq, Debug)]
pub struct QualityItem<T> { pub struct QualityItem<T> {
/// The actual contents of the field. /// The actual contents of the field.

View File

@ -59,7 +59,7 @@ where
} }
/// Percent encode a sequence of bytes with a character set defined in /// Percent encode a sequence of bytes with a character set defined in
/// <https://tools.ietf.org/html/rfc5987#section-3.2> /// <https://datatracker.ietf.org/doc/html/rfc5987#section-3.2>
#[inline] #[inline]
pub fn http_percent_encode(f: &mut fmt::Formatter<'_>, bytes: &[u8]) -> fmt::Result { pub fn http_percent_encode(f: &mut fmt::Formatter<'_>, bytes: &[u8]) -> fmt::Result {
let encoded = percent_encoding::percent_encode(bytes, HTTP_VALUE); let encoded = percent_encoding::percent_encode(bytes, HTTP_VALUE);

View File

@ -222,7 +222,8 @@ impl<T: Into<String>> From<(CloseCode, T)> for CloseReason {
} }
} }
/// The WebSocket GUID as stated in the spec. See <https://tools.ietf.org/html/rfc6455#section-1.3>. /// The WebSocket GUID as stated in the spec.
/// See <https://datatracker.ietf.org/doc/html/rfc6455#section-1.3>.
static WS_GUID: &[u8] = b"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; static WS_GUID: &[u8] = b"258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
/// Hashes the `Sec-WebSocket-Key` header according to the WebSocket spec. /// Hashes the `Sec-WebSocket-Key` header according to the WebSocket spec.

View File

@ -10,7 +10,7 @@ use derive_more::{Display, Error, From};
pub enum MultipartError { pub enum MultipartError {
/// Content-Disposition header is not found or is not equal to "form-data". /// Content-Disposition header is not found or is not equal to "form-data".
/// ///
/// According to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.2) a /// According to [RFC 7578 §4.2](https://datatracker.ietf.org/doc/html/rfc7578#section-4.2) a
/// Content-Disposition header must always be present and equal to "form-data". /// Content-Disposition header must always be present and equal to "form-data".
#[display(fmt = "No Content-Disposition `form-data` header")] #[display(fmt = "No Content-Disposition `form-data` header")]
NoContentDisposition, NoContentDisposition,

View File

@ -337,8 +337,8 @@ impl InnerMultipart {
return Poll::Pending; return Poll::Pending;
}; };
// According to [RFC 7578](https://tools.ietf.org/html/rfc7578#section-4.2) a // According to RFC 7578 §4.2, a Content-Disposition header must always be present and
// Content-Disposition header must always be present and set to "form-data". // set to "form-data".
let content_disposition = headers let content_disposition = headers
.get(&header::CONTENT_DISPOSITION) .get(&header::CONTENT_DISPOSITION)

View File

@ -66,8 +66,7 @@ where
let mut framed = Framed::new(io, h1::ClientCodec::default()); let mut framed = Framed::new(io, h1::ClientCodec::default());
// Check EXPECT header and enable expect handle flag accordingly. // Check EXPECT header and enable expect handle flag accordingly.
// // See https://datatracker.ietf.org/doc/html/rfc7231#section-5.1.1
// RFC: https://tools.ietf.org/html/rfc7231#section-5.1.1
let is_expect = if head.as_ref().headers.contains_key(EXPECT) { let is_expect = if head.as_ref().headers.contains_key(EXPECT) {
match body.size() { match body.size() {
BodySize::None | BodySize::Sized(0) => { BodySize::None | BodySize::Sized(0) => {

View File

@ -90,7 +90,7 @@ where
for (key, value) in headers { for (key, value) in headers {
match *key { match *key {
// TODO: consider skipping other headers according to: // TODO: consider skipping other headers according to:
// https://tools.ietf.org/html/rfc7540#section-8.1.2.2 // https://datatracker.ietf.org/doc/html/rfc7540#section-8.1.2.2
// omit HTTP/1.x only headers // omit HTTP/1.x only headers
CONNECTION | TRANSFER_ENCODING => continue, CONNECTION | TRANSFER_ENCODING => continue,
CONTENT_LENGTH if skip_len => continue, CONTENT_LENGTH if skip_len => continue,

View File

@ -153,7 +153,7 @@ impl Accept {
/// Returns a sorted list of mime types from highest to lowest preference, accounting for /// Returns a sorted list of mime types from highest to lowest preference, accounting for
/// [q-factor weighting] and specificity. /// [q-factor weighting] and specificity.
/// ///
/// [q-factor weighting]: https://tools.ietf.org/html/rfc7231#section-5.3.2 /// [q-factor weighting]: https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2
pub fn mime_precedence(&self) -> Vec<Mime> { pub fn mime_precedence(&self) -> Vec<Mime> {
let mut types = self.0.clone(); let mut types = self.0.clone();
@ -203,7 +203,7 @@ impl Accept {
/// ///
/// Returns `None` if contained list is empty. /// Returns `None` if contained list is empty.
/// ///
/// [q-factor weighting]: https://tools.ietf.org/html/rfc7231#section-5.3.2 /// [q-factor weighting]: https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2
pub fn mime_preference(&self) -> Option<Mime> { pub fn mime_preference(&self) -> Option<Mime> {
let types = self.mime_precedence(); let types = self.mime_precedence();
types.first().cloned() types.first().cloned()

View File

@ -3,8 +3,8 @@ use language_tags::LanguageTag;
use super::{QualityItem, ACCEPT_LANGUAGE}; use super::{QualityItem, ACCEPT_LANGUAGE};
crate::http::header::common_header! { crate::http::header::common_header! {
/// `Accept-Language` header, defined in /// `Accept-Language` header, defined
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.5) /// in [RFC 7231 §5.3.5](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5)
/// ///
/// The `Accept-Language` header field can be used by user agents to /// The `Accept-Language` header field can be used by user agents to
/// indicate the set of natural languages that are preferred in the /// indicate the set of natural languages that are preferred in the

View File

@ -204,9 +204,9 @@ impl DispositionParam {
/// A *Content-Disposition* header. It is compatible to be used either as /// A *Content-Disposition* header. It is compatible to be used either as
/// [a response header for the main body](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#as_a_response_header_for_the_main_body) /// [a response header for the main body](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#as_a_response_header_for_the_main_body)
/// as (re)defined in [RFC 6266](https://tools.ietf.org/html/rfc6266), or as /// as (re)defined in [RFC 6266](https://datatracker.ietf.org/doc/html/rfc6266), or as
/// [a header for a multipart body](https://mdn.io/Content-Disposition#As_a_header_for_a_multipart_body) /// [a header for a multipart body](https://mdn.io/Content-Disposition#As_a_header_for_a_multipart_body)
/// as (re)defined in [RFC 7587](https://tools.ietf.org/html/rfc7578). /// as (re)defined in [RFC 7587](https://datatracker.ietf.org/doc/html/rfc7578).
/// ///
/// In a regular HTTP response, the *Content-Disposition* response header is a header indicating if /// In a regular HTTP response, the *Content-Disposition* response header is a header indicating if
/// the content is expected to be displayed *inline* in the browser, that is, as a Web page or as /// the content is expected to be displayed *inline* in the browser, that is, as a Web page or as
@ -299,8 +299,9 @@ impl DispositionParam {
/// # Security Note /// # Security Note
/// If "filename" parameter is supplied, do not use the file name blindly, check and possibly /// If "filename" parameter is supplied, do not use the file name blindly, check and possibly
/// change to match local file system conventions if applicable, and do not use directory path /// change to match local file system conventions if applicable, and do not use directory path
/// information that may be present. See [RFC 2183](https://tools.ietf.org/html/rfc2183#section-2.3). /// information that may be present.
// TODO: private fields and use smallvec /// See [RFC 2183 §2.3](https://datatracker.ietf.org/doc/html/rfc2183#section-2.3).
// TODO: think about using private fields and smallvec
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
pub struct ContentDisposition { pub struct ContentDisposition {
/// The disposition type /// The disposition type

View File

@ -71,7 +71,8 @@ crate::http::header::common_header! {
} }
} }
/// Content-Range, described in [RFC 7233](https://tools.ietf.org/html/rfc7233#section-4.2) /// Content-Range header, defined
/// in [RFC 7233 §4.2](https://datatracker.ietf.org/doc/html/rfc7233#section-4.2)
/// ///
/// # ABNF /// # ABNF
/// ```text /// ```text

View File

@ -93,7 +93,7 @@ impl ByteRangeSpec {
/// simply ignore the range header and serve the full entity using a `200 /// simply ignore the range header and serve the full entity using a `200
/// OK` status code. /// OK` status code.
/// ///
/// This function closely follows [RFC 7233][1] section 2.1. /// This function closely follows [RFC 7233 §2.1].
/// As such, it considers ranges to be satisfiable if they meet the /// As such, it considers ranges to be satisfiable if they meet the
/// following conditions: /// following conditions:
/// ///
@ -112,7 +112,7 @@ impl ByteRangeSpec {
/// value of last-byte-pos with a value that is one less than the current /// value of last-byte-pos with a value that is one less than the current
/// length of the selected representation). /// length of the selected representation).
/// ///
/// [1]: https://tools.ietf.org/html/rfc7233 /// [RFC 7233 §2.1]: https://datatracker.ietf.org/doc/html/rfc7233
pub fn to_satisfiable_range(&self, full_length: u64) -> Option<(u64, u64)> { pub fn to_satisfiable_range(&self, full_length: u64) -> Option<(u64, u64)> {
// If the full length is zero, there is no satisfiable end-inclusive range. // If the full length is zero, there is no satisfiable end-inclusive range.
if full_length == 0 { if full_length == 0 {