Expand description

Structs representing headers relevant in a WebSocket context.

These headers are commonly used in WebSocket requests and responses. The Header trait from the hyper crate is used.

Re-exports

pub use self::extensions::WebSocketExtensions;

Modules

Provides the Sec-WebSocket-Extensions header.

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-Range header, defined in RFC7233

Content-Type header, defined in RFC7231

Cookie header, defined in RFC6265

Date header, defined in RFC7231

ETag header, defined in RFC7232

An entity tag, defined in RFC7232

Expires header, defined in RFC7234

From header, defined in RFC7231

HeaderFormatterDeprecated

A wrapper around any Header with a Display impl that calls fmt_header.

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 time::Time with HTTP formatting and parsing

If-Modified-Since header, defined in RFC7232

If-Unmodified-Since header, defined in RFC7232

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

Represents an Origin header

Prefer header, defined in RFC7240

Preference-Applied header, defined in RFC7240

Protocols that appear in the Upgrade header field

Represents a quality used in quality values.

Represents an item with a quality value as defined in RFC7231.

Referer header, defined in RFC7231

Server header, defined in RFC7231

Set-Cookie header, defined RFC6265

StrictTransportSecurity header, defined in RFC6797

Transfer-Encoding header, defined in RFC7230

Upgrade header, defined in RFC7230

User-Agent header, defined in RFC7231

Represents a Sec-WebSocket-Accept header

Represents a Sec-WebSocket-Key header.

Represents a Sec-WebSocket-Protocol header

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.

The Expect header.

If-Match header, defined in RFC7232

If-None-Match header, defined in RFC7232

If-Range header, defined in RFC7233

A Media Descriptors Enum based on: https://www.w3.org/TR/html401/types.html#h-6.13

The Pragma header defined by HTTP/1.0.

Prefer contains a list of these preferences.

A protocol name used to identify a spefic 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

Vary header, defined in RFC7231

Represents a Sec-WebSocket-Version header

Traits

A trait for any object that will represent a header field and value.

Internal implementation detail.

A trait for any object that will represent a header field and value.

An Authorization scheme to be used in the header.

Functions

Convenience function to create a Quality from a float.

Convinience function to wrap a value in a QualityItem Sets q to the default 1.0