Module saphir::header

source ·
Expand description

Headers types re-export

Re-exports

pub use hyperx::mime;

Modules

Utility functions for Header implementations.

Structs

Accept header, defined in RFC7231
Accept-Charset header, defined in RFC7231
Accept-Encoding header, defined in RFC7231
Accept-Language header, defined in RFC7231
Accept-Ranges header, defined in RFC7233
Access-Control-Allow-Credentials header, part of CORS
Access-Control-Allow-Headers header, part of CORS
Access-Control-Allow-Methods header, part of CORS
Access-Control-Expose-Headers header, part of CORS
Access-Control-Max-Age header, part of CORS
Access-Control-Request-Headers header, part of CORS
Access-Control-Request-Method header, part of CORS
Allow header, defined in RFC7231
Authorization header, defined in RFC7235
Credential holder for Basic Authentication
Token holder for Bearer Authentication, most often seen with oauth
Cache-Control header, defined in RFC7234
Connection header, defined in RFC7230
A Content-Disposition header, (re)defined in RFC6266.
Content-Encoding header, defined in RFC7231
Content-Language header, defined in RFC7231
Content-Length header, defined in RFC7230
Content-Location header, defined in RFC7231
Content-Range header, defined in RFC7233
Content-Type header, defined in RFC7231
Cookie header, defined in RFC6265
Iterator for cookie.
Date header, defined in RFC7231
A drain iterator for HeaderMap.
ETag header, defined in RFC7232
An entity tag, defined in RFC7232
Expires header, defined in RFC7234
A formatter used to serialize headers to an output stream.
A view to all values stored in a single entry.
A set of HTTP headers
Represents an HTTP header field name
Represents an HTTP header field value.
Returned with the HeadersItems iterator.
A map of header fields on requests and responses.
An Iterator over the fields in a Headers map.
The Host header.
A timestamp with HTTP formatting and parsing
If-Modified-Since header, defined in RFC7232
If-Unmodified-Since header, defined in RFC7232
An owning iterator over the entries of a HeaderMap.
A possible error when converting a HeaderName from another type.
A possible error when converting a HeaderName from another type.
A possible error when converting a HeaderValue from a string or byte slice.
A possible error when converting a HeaderValue from a string or byte slice.
HeaderMap entry iterator.
HeaderMap mutable entry iterator
An iterator over HeaderMap keys.
A language tag as described in BCP47.
Last-Event-ID header, defined in RFC3864
Last-Modified header, defined in RFC7232
The Link header, defined in RFC5988
A single link-value of a Link header, based on: RFC5988
Location header, defined in RFC7231
A view into a single occupied location in a HeaderMap.
The Origin header.
Prefer header, defined in RFC7240
Preference-Applied header, defined in RFC7240
Protocols that appear in the Upgrade header field
Proxy-Authorization header, defined in RFC7235
Represents a quality used in quality values.
Represents an item with a quality value as defined in RFC7231.
A raw header value.
Referer header, defined in RFC7231
Server header, defined in RFC7231
Set-Cookie header, defined RFC6265
StrictTransportSecurity header, defined in RFC6797
TE header, defined in RFC7230
A possible error when converting a HeaderValue to a string representation.
Transfer-Encoding header, defined in RFC7230
Upgrade header, defined in RFC7230
User-Agent header, defined in RFC7231
A view into a single empty location in a HeaderMap.
An drain iterator of all values associated with a single header name.
An iterator of all values associated with a single header name.
A mutable iterator of all values associated with a single header name.
HeaderMap value iterator.
HeaderMap mutable value iterator
Warning header, defined in RFC7234

Enums

The Access-Control-Allow-Origin response header, part of CORS
Each Range::Bytes header can contain one or more ByteRangeSpecs. Each ByteRangeSpec defines a range of bytes to fetch
CacheControl contains a list of these directives.
A Mime charset.
Values that can be in the Connection header.
Content-Range, described in RFC7233
A parameter to the disposition type.
The implied disposition of the content of the HTTP body.
A value to represent an encoding used in Transfer-Encoding or Accept-Encoding header.
A view into a single location in a HeaderMap, which may be vacant or occupied.
The Expect header.
If-Match header, defined in RFC7232
If-None-Match header, defined in RFC7232
If-Range header, defined in RFC7233
The Pragma header defined by HTTP/1.0.
Prefer contains a list of these preferences.
A protocol name used to identify a specific protocol. Names are case-sensitive except for the WebSocket value.
Range header, defined in RFC7233
Range Units, described in RFC7233
Referrer-Policy header, part of Referrer Policy
A Link Relation Type Enum based on: RFC5988
The Retry-After header.
Vary header, defined in RFC7231

Constants

Advertises which content types the client is able to understand.
Advertises which character set the client is able to understand.
Advertises which content encoding the client is able to understand.
Advertises which languages the client is able to understand.
Marker used by the server to advertise partial request support.
Preflight response indicating if the response to the request can be exposed to the page.
Preflight response indicating permitted HTTP headers.
Preflight header response indicating permitted access methods.
Indicates whether the response can be shared with resources with the given origin.
Indicates which headers can be exposed as part of the response by listing their names.
Indicates how long the results of a preflight request can be cached.
Informs the server which HTTP headers will be used when an actual request is made.
Informs the server know which HTTP method will be used when the actual request is made.
Indicates the time in seconds the object has been in a proxy cache.
Lists the set of methods support by a resource.
Advertises the availability of alternate services to clients.
Contains the credentials to authenticate a user agent with a server.
Specifies directives for caching mechanisms in both requests and responses.
Controls whether or not the network connection stays open after the current transaction finishes.
Indicates if the content is expected to be displayed inline.
Used to compress the media-type.
Used to describe the languages intended for the audience.
Indicates the size fo the entity-body.
Indicates an alternate location for the returned data.
Indicates where in a full body message a partial message belongs.
Allows controlling resources the user agent is allowed to load for a given page.
Allows experimenting with policies by monitoring their effects.
Used to indicate the media type of the resource.
Contains stored HTTP cookies previously sent by the server with the Set-Cookie header.
Contains the date and time at which the message was originated.
Indicates the client’s tracking preference.
Identifier for a specific version of a resource.
Indicates expectations that need to be fulfilled by the server in order to properly handle the request.
Contains the date/time after which the response is considered stale.
Contains information from the client-facing side of proxy servers that is altered or lost when a proxy is involved in the path of the request.
Contains an Internet email address for a human user who controls the requesting user agent.
Specifies the domain name of the server and (optionally) the TCP port number on which the server is listening.
Makes a request conditional based on the E-Tag.
Makes a request conditional based on the modification date.
Makes a request conditional based on the E-Tag.
Makes a request conditional based on range.
Makes the request conditional based on the last modification date.
Content-Types that are acceptable for the response.
Allows the server to point an interested client to another resource containing metadata about the requested resource.
Indicates the URL to redirect a page to.
Indicates the max number of intermediaries the request should be sent through.
Indicates where a fetch originates from.
HTTP/1.0 header usually used for backwards compatibility.
Defines the authentication method that should be used to gain access to a proxy.
Contains the credentials to authenticate a user agent to a proxy server.
Associates a specific cryptographic public key with a certain server.
Sends reports of pinning violation to the report-uri specified in the header.
Indicates the part of a document that the server should return.
Contains the address of the previous web page from which a link to the currently requested page was followed.
Governs which referrer information should be included with requests made.
Informs the web browser that the current page or frame should be refreshed.
The Retry-After response HTTP header indicates how long the user agent should wait before making a follow-up request. There are two main cases this header is used:
The |Sec-WebSocket-Accept| header field is used in the WebSocket opening handshake. It is sent from the server to the client to confirm that the server is willing to initiate the WebSocket connection.
The |Sec-WebSocket-Extensions| header field is used in the WebSocket opening handshake. It is initially sent from the client to the server, and then subsequently sent from the server to the client, to agree on a set of protocol-level extensions to use for the duration of the connection.
The |Sec-WebSocket-Key| header field is used in the WebSocket opening handshake. It is sent from the client to the server to provide part of the information used by the server to prove that it received a valid WebSocket opening handshake. This helps ensure that the server does not accept connections from non-WebSocket clients (e.g., HTTP clients) that are being abused to send data to unsuspecting WebSocket servers.
The |Sec-WebSocket-Protocol| header field is used in the WebSocket opening handshake. It is sent from the client to the server and back from the server to the client to confirm the subprotocol of the connection. This enables scripts to both select a subprotocol and be sure that the server agreed to serve that subprotocol.
The |Sec-WebSocket-Version| header field is used in the WebSocket opening handshake. It is sent from the client to the server to indicate the protocol version of the connection. This enables servers to correctly interpret the opening handshake and subsequent data being sent from the data, and close the connection if the server cannot interpret that data in a safe manner.
Contains information about the software used by the origin server to handle the request.
Used to send cookies from the server to the user agent.
Tells the client to communicate with HTTPS instead of using HTTP.
Informs the server of transfer encodings willing to be accepted as part of the response.
Allows the sender to include additional fields at the end of chunked messages.
Specifies the form of encoding used to safely transfer the entity to the client.
Used as part of the exchange to upgrade the protocol.
Sends a signal to the server expressing the client’s preference for an encrypted and authenticated response.
Contains a string that allows identifying the requesting client’s software.
Determines how to match future requests with cached responses.
Added by proxies to track routing.
General HTTP header contains information about possible problems with the status of the message.
Defines the authentication method that should be used to gain access to a resource.
Marker used by the server to indicate that the MIME types advertised in the content-type headers should not be changed and be followed.
Controls DNS prefetching.
Indicates whether or not a browser should be allowed to render a page in a frame.
Stop pages from loading when an XSS attack is detected.

Traits

A marker trait used to identify values that can be used as search keys to a HeaderMap.
A trait for any object that will represent a header field and value.
A marker trait used to identify values that can be used as insert keys to a HeaderMap.
An Authorization scheme to be used in the header.

Functions

Convenience function to create a Quality from a float or integer.
Convenience function to wrap a value in a QualityItem Sets q to the default 1.0