Request

public struct Request

Represent HTTP request.

Show on GitHub

  • Request HTTP method, defaults to GET.

    Declaration

    Swift

    public let method: HTTPMethod
    Show on GitHub
  • url

    Remote URL.

    Declaration

    Swift

    public let url: URL
    Show on GitHub

  • Remote HTTP scheme, resolved from URL.

    Declaration

    Swift

    public let scheme: String
    Show on GitHub

  • Remote host, resolved from URL.

    Declaration

    Swift

    public let host: String
    Show on GitHub

  • Request custom HTTP Headers, defaults to no headers.

    Declaration

    Swift

    public var headers: HTTPHeaders
    Show on GitHub

  • Request body, defaults to no body.

    Declaration

    Swift

    public var body: Body?
    Show on GitHub

  • Request-specific TLS configuration, defaults to no request-specific TLS configuration.

    Declaration

    Swift

    public var tlsConfiguration: TLSConfiguration?
    Show on GitHub

  • Create HTTP request.

    Throws

    • invalidURL if URL cannot be parsed.
    • emptyScheme if URL does not contain HTTP scheme.
    • unsupportedScheme if URL does contains unsupported HTTP scheme.
    • emptyHost if URL does not contains a host.

    Declaration

    Swift

    public init(url: String, method: HTTPMethod = .GET, headers: HTTPHeaders = HTTPHeaders(), body: Body? = nil) throws

    Parameters

    url

    Remote URL.
    version

    HTTP version.
    method

    HTTP method.
    headers

    Custom HTTP headers.
    body

    Request body.
    Show on GitHub

  • Create HTTP request.

    Throws

    • invalidURL if URL cannot be parsed.
    • emptyScheme if URL does not contain HTTP scheme.
    • unsupportedScheme if URL does contains unsupported HTTP scheme.
    • emptyHost if URL does not contains a host.

    Declaration

    Swift

    public init(url: String, method: HTTPMethod = .GET, headers: HTTPHeaders = HTTPHeaders(), body: Body? = nil, tlsConfiguration: TLSConfiguration?) throws

    Parameters

    url

    Remote URL.
    version

    HTTP version.
    method

    HTTP method.
    headers

    Custom HTTP headers.
    body

    Request body.
    tlsConfiguration

    Request TLS configuration
    Show on GitHub

  • Create an HTTP Request.

    Throws

    • emptyScheme if URL does not contain HTTP scheme.
    • unsupportedScheme if URL does contains unsupported HTTP scheme.
    • emptyHost if URL does not contains a host.
    • missingSocketPath if URL does not contains a socketPath as an encoded host.

    Declaration

    Swift

    public init(url: URL, method: HTTPMethod = .GET, headers: HTTPHeaders = HTTPHeaders(), body: Body? = nil) throws

    Parameters

    url

    Remote URL.
    method

    HTTP method.
    headers

    Custom HTTP headers.
    body

    Request body.
    Show on GitHub

  • Create an HTTP Request.

    Throws

    • emptyScheme if URL does not contain HTTP scheme.
    • unsupportedScheme if URL does contains unsupported HTTP scheme.
    • emptyHost if URL does not contains a host.
    • missingSocketPath if URL does not contains a socketPath as an encoded host.

    Declaration

    Swift

    public init(url: URL, method: HTTPMethod = .GET, headers: HTTPHeaders = HTTPHeaders(), body: Body? = nil, tlsConfiguration: TLSConfiguration?) throws

    Parameters

    url

    Remote URL.
    method

    HTTP method.
    headers

    Custom HTTP headers.
    body

    Request body.
    tlsConfiguration

    Request TLS configuration
    Show on GitHub

  • Whether request will be executed using secure socket.

    Declaration

    Swift

    public var useTLS: Bool { get }
    Show on GitHub

  • Resolved port.

    Declaration

    Swift

    public var port: Int { get }
    Show on GitHub