HTTPHeaders

Topics

Structures

• struct CacheControl
  Represents the HTTP Cache-Control header.
• struct Connection
• struct ContentDisposition
• struct ContentRange
  Represents the HTTP Content-Range response header.
• struct Expires
• struct Forwarded
  Parses the Forwarded header.
• struct LastModified
  Represents the HTTP Last-Modified header.
• struct Link
• struct Name
  Type used for the name of a HTTP header in the HTTPHeaders storage.
• struct Range
  Represents the HTTP Range request header. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range
• struct ResponseCompression
  A marker header internal to vapor that explicitly allows or disallows response compression.

Instance Properties

• var accept: [HTTPMediaTypePreference]
  Returns a collection of MediaTypePreferences specified by this HTTP message’s "Accept" header.
• var basicAuthorization: BasicAuthorization?
  Access or set the Authorization: Basic: ... header.
• var bearerAuthorization: BearerAuthorization?
  Access or set the Authorization: Bearer: ... header.
• var cacheControl: HTTPHeaders.CacheControl?
  Gets the value of the Cache-Control header, if present.
• var connection: HTTPHeaders.Connection?
• var contentDisposition: HTTPHeaders.ContentDisposition?
  Convenience for accessing the Content-Disposition header.
• var contentRange: HTTPHeaders.ContentRange?
  Convenience for accessing the Content-Range response header.
• var contentType: HTTPMediaType?
  MediaType specified by this message’s "Content-Type" header.
• var cookie: HTTPCookies?
  Get and set HTTPCookies for an HTTP request This accesses the "Cookie" header.
• var expires: HTTPHeaders.Expires?
  Gets the value of the Expires header, if present.
• var forwarded: [HTTPHeaders.Forwarded]
  Convenience for accessing the Forwarded header. This header is added by proxies to pass information about the original request.
• var lastModified: HTTPHeaders.LastModified?
• var links: [HTTPHeaders.Link]?
  Convenience for accessing the Link header as an array of provided links.
• var range: HTTPHeaders.Range?
  Convenience for accessing the Range request header.
• var responseCompression: HTTPHeaders.ResponseCompression
  A marker header internal to vapor that explicitly allows or disallows response compression.
• var setCookie: HTTPCookies?
  Get and set HTTPCookies for an HTTP response This accesses the "Set-Cookie" header.

Instance Methods

• func add(name: HTTPHeaders.Name, value: String)
  Add a header name/value pair to the block.
• func contains(name: HTTPHeaders.Name) -> Bool
  Returns true if the HTTPHeaders contains a value for the supplied name.
• func expirationDate(requestSentAt: Date) -> Date?
  Determines when the cached data should be expired.
• func first(name: HTTPHeaders.Name) -> String?
  Returns the first header value with the supplied name.
• func remove(name: HTTPHeaders.Name)
  Remove all values for a given header name from the block.
• func replaceOrAdd(name: HTTPHeaders.Name, value: String)
  Add a header name/value pair to the block, replacing any previous values for the same header name that are already in the block.

Subscripts

• subscript(HTTPHeaders.Name) -> [String]
  Retrieve all of the values for a given header field name from the block.
• subscript(canonicalForm _: HTTPHeaders.Name) -> [Substring]

Enumerations

• enum RangeUnit
  The unit in which ContentRanges and Ranges are specified. This is usually bytes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range

Default Implementations

• CustomDebugStringConvertible Implementations
• Decodable Implementations
• Encodable Implementations