URLRequest Extension Reference


                    
                    
                    MultipartAttachment

Struct representing a multipart attachment to a multipart form data request

Declaration

Swift

public struct MultipartAttachment : Equatable


                    
                    
                    MultipartAttachments

A typealias for an array of MultipartAttachment

Declaration

Swift

public typealias MultipartAttachments = [MultipartAttachment]


                    
                    
                    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:)

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) 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.


                    
                    
                    encode(with:)

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?) throws

Parameters


                                parameters

The Parameters to apply.


                    
                    
                    encode(_:with:)

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?) throws

Parameters

`urlRequest`	The `URLRequest` to have parameters applied.
`parameters`	The `Parameters` to apply.

URLRequest

Declaration