URLRequest

extension URLRequest: URLRequestConvertible


                    
                    
                    asURLRequest()

Returns self.

Declaration

Swift

public func asURLRequest() throws -> URLRequest

URLRequest extension


                    
                    
                    init(url:method:headers:)

Creates a URLRequest instance with the specified url, method, and headers.

Throws

Any error thrown while trying to convert the URLConvertible to a URL.

Declaration

Swift

public init(url: URLConvertible, method: HTTPMethod, headers: HTTPHeaders? = nil) throws

Parameters

`url`	A `URLConvertible` value.
`method`	An `HTTPMethod`.
`headers`	The `HTTPHeaders`, `nil` by default.


                    
                    
                    init(url:method:headers:parameters:multipartAttachments:encoding:)

Creates a URLRequest instance with the specified url, method, headers, parameters and multipart attachments.

Throws

Any error thrown while trying to convert the URLConvertible to a URL.

Declaration

Swift

public init(url: URLConvertible,
            method: HTTPMethod,
            headers: HTTPHeaders? = nil,
            parameters: Parameters?,
            multipartAttachments: MultipartAttachments? = nil,
            encoding: ParameterEncoding = .urlEncodedForm) throws

Parameters

`url`	A `URLConvertible` value.
`method`	An `HTTPMethod`.
`headers`	The `HTTPHeaders`, `nil` by default.
`parameters`	A `Parameters` value
`multipartAttachments`	An array of `URL`s of the attachments.
`encoding`	The parameter encoding type to use.


                    
                    
                    encode(with:encoding:)

Encodes parameters and applies them to the URLRequest.

Throws

An Error if the encoding process encounters an error.

Declaration

Swift

public mutating func encode(with parameters: Parameters?,
                            encoding: ParameterEncoding = .urlEncodedForm) throws

Parameters

`parameters`	The `Parameters` to apply.
`encoding`	The parameter encoding type to use.


                    
                    
                    encode(_:with:encoding:)

Encodes parameters by applying them to an existing URLRequest.

Throws

An Error if the encoding process encounters an error.

Declaration

Swift

public static func encode(_ urlRequest: inout URLRequest,
                          with parameters: Parameters?,
                          encoding: ParameterEncoding = .urlEncodedForm) throws

Parameters

`urlRequest`	The `URLRequest` to have parameters applied.
`parameters`	The `Parameters` to apply.
`encoding`	The parameter encoding type to use.