mirror of
https://github.com/actix/actix-web.git
synced 2024-06-02 13:29:24 +00:00
94 lines
3.4 KiB
Rust
94 lines
3.4 KiB
Rust
//! Pre-defined `HeaderName`s, traits for parsing and conversion, and other header utility methods.
|
|
|
|
// declaring new header consts will yield this error
|
|
#![allow(clippy::declare_interior_mutable_const)]
|
|
|
|
use percent_encoding::{AsciiSet, CONTROLS};
|
|
|
|
// re-export from http except header map related items
|
|
pub use ::http::header::{
|
|
HeaderName, HeaderValue, InvalidHeaderName, InvalidHeaderValue, ToStrError,
|
|
};
|
|
|
|
// re-export const header names, list is explicit so that any updates to `common` module do not
|
|
// conflict with this set
|
|
pub use ::http::header::{
|
|
ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES,
|
|
ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS,
|
|
ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS,
|
|
ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE,
|
|
ALLOW, ALT_SVC, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_DISPOSITION,
|
|
CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_RANGE,
|
|
CONTENT_SECURITY_POLICY, CONTENT_SECURITY_POLICY_REPORT_ONLY, CONTENT_TYPE, COOKIE, DATE,
|
|
DNT, ETAG, EXPECT, EXPIRES, FORWARDED, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE,
|
|
IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LINK, LOCATION, MAX_FORWARDS,
|
|
ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PUBLIC_KEY_PINS,
|
|
PUBLIC_KEY_PINS_REPORT_ONLY, RANGE, REFERER, REFERRER_POLICY, REFRESH, RETRY_AFTER,
|
|
SEC_WEBSOCKET_ACCEPT, SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_KEY, SEC_WEBSOCKET_PROTOCOL,
|
|
SEC_WEBSOCKET_VERSION, SERVER, SET_COOKIE, STRICT_TRANSPORT_SECURITY, TE, TRAILER,
|
|
TRANSFER_ENCODING, UPGRADE, UPGRADE_INSECURE_REQUESTS, USER_AGENT, VARY, VIA, WARNING,
|
|
WWW_AUTHENTICATE, X_CONTENT_TYPE_OPTIONS, X_DNS_PREFETCH_CONTROL, X_FRAME_OPTIONS,
|
|
X_XSS_PROTECTION,
|
|
};
|
|
|
|
use crate::{error::ParseError, HttpMessage};
|
|
|
|
mod as_name;
|
|
mod common;
|
|
mod into_pair;
|
|
mod into_value;
|
|
pub mod map;
|
|
mod shared;
|
|
mod utils;
|
|
|
|
pub use self::{
|
|
as_name::AsHeaderName,
|
|
into_pair::TryIntoHeaderPair,
|
|
into_value::TryIntoHeaderValue,
|
|
map::HeaderMap,
|
|
shared::{
|
|
parse_extended_value, q, Charset, ContentEncoding, ExtendedValue, HttpDate,
|
|
LanguageTag, Quality, QualityItem,
|
|
},
|
|
utils::{fmt_comma_delimited, from_comma_delimited, from_one_raw_str, http_percent_encode},
|
|
};
|
|
|
|
// re-export list is explicit so that any updates to `http` do not conflict with this set
|
|
pub use self::common::{
|
|
CROSS_ORIGIN_EMBEDDER_POLICY, CROSS_ORIGIN_OPENER_POLICY, CROSS_ORIGIN_RESOURCE_POLICY,
|
|
PERMISSIONS_POLICY, X_FORWARDED_FOR, X_FORWARDED_HOST, X_FORWARDED_PROTO,
|
|
};
|
|
|
|
/// An interface for types that already represent a valid header.
|
|
pub trait Header: TryIntoHeaderValue {
|
|
/// Returns the name of the header field.
|
|
fn name() -> HeaderName;
|
|
|
|
/// Parse the header from a HTTP message.
|
|
fn parse<M: HttpMessage>(msg: &M) -> Result<Self, ParseError>;
|
|
}
|
|
|
|
/// This encode set is used for HTTP header values and is defined at
|
|
/// <https://datatracker.ietf.org/doc/html/rfc5987#section-3.2>.
|
|
pub(crate) const HTTP_VALUE: &AsciiSet = &CONTROLS
|
|
.add(b' ')
|
|
.add(b'"')
|
|
.add(b'%')
|
|
.add(b'\'')
|
|
.add(b'(')
|
|
.add(b')')
|
|
.add(b'*')
|
|
.add(b',')
|
|
.add(b'/')
|
|
.add(b':')
|
|
.add(b';')
|
|
.add(b'<')
|
|
.add(b'-')
|
|
.add(b'>')
|
|
.add(b'?')
|
|
.add(b'[')
|
|
.add(b'\\')
|
|
.add(b']')
|
|
.add(b'{')
|
|
.add(b'}');
|