123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655 |
- //
- // Combine.swift
- //
- // Copyright (c) 2020 Alamofire Software Foundation (http://alamofire.org/)
- //
- // Permission is hereby granted, free of charge, to any person obtaining a copy
- // of this software and associated documentation files (the "Software"), to deal
- // in the Software without restriction, including without limitation the rights
- // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- // copies of the Software, and to permit persons to whom the Software is
- // furnished to do so, subject to the following conditions:
- //
- // The above copyright notice and this permission notice shall be included in
- // all copies or substantial portions of the Software.
- //
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- // THE SOFTWARE.
- //
- #if !((os(iOS) && (arch(i386) || arch(arm))) || os(Windows) || os(Linux))
- import Combine
- import Dispatch
- import Foundation
- // MARK: - DataRequest / UploadRequest
- /// A Combine `Publisher` that publishes the `DataResponse<Value, AFError>` of the provided `DataRequest`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public struct DataResponsePublisher<Value>: Publisher {
- public typealias Output = DataResponse<Value, AFError>
- public typealias Failure = Never
- private typealias Handler = (@escaping (_ response: DataResponse<Value, AFError>) -> Void) -> DataRequest
- private let request: DataRequest
- private let responseHandler: Handler
- /// Creates an instance which will serialize responses using the provided `ResponseSerializer`.
- ///
- /// - Parameters:
- /// - request: `DataRequest` for which to publish the response.
- /// - queue: `DispatchQueue` on which the `DataResponse` value will be published. `.main` by default.
- /// - serializer: `ResponseSerializer` used to produce the published `DataResponse`.
- public init<Serializer: ResponseSerializer>(_ request: DataRequest, queue: DispatchQueue, serializer: Serializer)
- where Value == Serializer.SerializedObject {
- self.request = request
- responseHandler = { request.response(queue: queue, responseSerializer: serializer, completionHandler: $0) }
- }
- /// Creates an instance which will serialize responses using the provided `DataResponseSerializerProtocol`.
- ///
- /// - Parameters:
- /// - request: `DataRequest` for which to publish the response.
- /// - queue: `DispatchQueue` on which the `DataResponse` value will be published. `.main` by default.
- /// - serializer: `DataResponseSerializerProtocol` used to produce the published `DataResponse`.
- public init<Serializer: DataResponseSerializerProtocol>(_ request: DataRequest,
- queue: DispatchQueue,
- serializer: Serializer)
- where Value == Serializer.SerializedObject {
- self.request = request
- responseHandler = { request.response(queue: queue, responseSerializer: serializer, completionHandler: $0) }
- }
- /// Publishes only the `Result` of the `DataResponse` value.
- ///
- /// - Returns: The `AnyPublisher` publishing the `Result<Value, AFError>` value.
- public func result() -> AnyPublisher<Result<Value, AFError>, Never> {
- map(\.result).eraseToAnyPublisher()
- }
- /// Publishes the `Result` of the `DataResponse` as a single `Value` or fail with the `AFError` instance.
- ///
- /// - Returns: The `AnyPublisher<Value, AFError>` publishing the stream.
- public func value() -> AnyPublisher<Value, AFError> {
- setFailureType(to: AFError.self).flatMap(\.result.publisher).eraseToAnyPublisher()
- }
- public func receive<S>(subscriber: S) where S: Subscriber, DataResponsePublisher.Failure == S.Failure, DataResponsePublisher.Output == S.Input {
- subscriber.receive(subscription: Inner(request: request,
- responseHandler: responseHandler,
- downstream: subscriber))
- }
- private final class Inner<Downstream: Subscriber>: Subscription
- where Downstream.Input == Output {
- typealias Failure = Downstream.Failure
- @Protected
- private var downstream: Downstream?
- private let request: DataRequest
- private let responseHandler: Handler
- init(request: DataRequest, responseHandler: @escaping Handler, downstream: Downstream) {
- self.request = request
- self.responseHandler = responseHandler
- self.downstream = downstream
- }
- func request(_ demand: Subscribers.Demand) {
- assert(demand > 0)
- guard let downstream = downstream else { return }
- self.downstream = nil
- responseHandler { response in
- _ = downstream.receive(response)
- downstream.receive(completion: .finished)
- }.resume()
- }
- func cancel() {
- request.cancel()
- downstream = nil
- }
- }
- }
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- extension DataResponsePublisher where Value == Data? {
- /// Creates an instance which publishes a `DataResponse<Data?, AFError>` value without serialization.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public init(_ request: DataRequest, queue: DispatchQueue) {
- self.request = request
- responseHandler = { request.response(queue: queue, completionHandler: $0) }
- }
- }
- extension DataRequest {
- /// Creates a `DataResponsePublisher` for this instance using the given `ResponseSerializer` and `DispatchQueue`.
- ///
- /// - Parameters:
- /// - serializer: `ResponseSerializer` used to serialize response `Data`.
- /// - queue: `DispatchQueue` on which the `DataResponse` will be published. `.main` by default.
- ///
- /// - Returns: The `DataResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishResponse<Serializer: ResponseSerializer, T>(using serializer: Serializer, on queue: DispatchQueue = .main) -> DataResponsePublisher<T>
- where Serializer.SerializedObject == T {
- DataResponsePublisher(self, queue: queue, serializer: serializer)
- }
- /// Creates a `DataResponsePublisher` for this instance and uses a `DataResponseSerializer` to serialize the
- /// response.
- ///
- /// - Parameters:
- /// - queue: `DispatchQueue` on which the `DataResponse` will be published. `.main` by default.
- /// - preprocessor: `DataPreprocessor` which filters the `Data` before serialization. `PassthroughPreprocessor()`
- /// by default.
- /// - emptyResponseCodes: `Set<Int>` of HTTP status codes for which empty responses are allowed. `[204, 205]` by
- /// default.
- /// - emptyRequestMethods: `Set<HTTPMethod>` of `HTTPMethod`s for which empty responses are allowed, regardless of
- /// status code. `[.head]` by default.
- /// - Returns: The `DataResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishData(queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = DataResponseSerializer.defaultDataPreprocessor,
- emptyResponseCodes: Set<Int> = DataResponseSerializer.defaultEmptyResponseCodes,
- emptyRequestMethods: Set<HTTPMethod> = DataResponseSerializer.defaultEmptyRequestMethods) -> DataResponsePublisher<Data> {
- publishResponse(using: DataResponseSerializer(dataPreprocessor: preprocessor,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyRequestMethods),
- on: queue)
- }
- /// Creates a `DataResponsePublisher` for this instance and uses a `StringResponseSerializer` to serialize the
- /// response.
- ///
- /// - Parameters:
- /// - queue: `DispatchQueue` on which the `DataResponse` will be published. `.main` by default.
- /// - preprocessor: `DataPreprocessor` which filters the `Data` before serialization. `PassthroughPreprocessor()`
- /// by default.
- /// - encoding: `String.Encoding` to parse the response. `nil` by default, in which case the encoding
- /// will be determined by the server response, falling back to the default HTTP character
- /// set, `ISO-8859-1`.
- /// - emptyResponseCodes: `Set<Int>` of HTTP status codes for which empty responses are allowed. `[204, 205]` by
- /// default.
- /// - emptyRequestMethods: `Set<HTTPMethod>` of `HTTPMethod`s for which empty responses are allowed, regardless of
- /// status code. `[.head]` by default.
- ///
- /// - Returns: The `DataResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishString(queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = StringResponseSerializer.defaultDataPreprocessor,
- encoding: String.Encoding? = nil,
- emptyResponseCodes: Set<Int> = StringResponseSerializer.defaultEmptyResponseCodes,
- emptyRequestMethods: Set<HTTPMethod> = StringResponseSerializer.defaultEmptyRequestMethods) -> DataResponsePublisher<String> {
- publishResponse(using: StringResponseSerializer(dataPreprocessor: preprocessor,
- encoding: encoding,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyRequestMethods),
- on: queue)
- }
- @_disfavoredOverload
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- @available(*, deprecated, message: "Renamed publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyRequestMethods).")
- public func publishDecodable<T: Decodable>(type: T.Type = T.self,
- queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = DecodableResponseSerializer<T>.defaultDataPreprocessor,
- decoder: DataDecoder = JSONDecoder(),
- emptyResponseCodes: Set<Int> = DecodableResponseSerializer<T>.defaultEmptyResponseCodes,
- emptyResponseMethods: Set<HTTPMethod> = DecodableResponseSerializer<T>.defaultEmptyRequestMethods) -> DataResponsePublisher<T> {
- publishResponse(using: DecodableResponseSerializer(dataPreprocessor: preprocessor,
- decoder: decoder,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyResponseMethods),
- on: queue)
- }
- /// Creates a `DataResponsePublisher` for this instance and uses a `DecodableResponseSerializer` to serialize the
- /// response.
- ///
- /// - Parameters:
- /// - type: `Decodable` type to which to decode response `Data`. Inferred from the context by
- /// default.
- /// - queue: `DispatchQueue` on which the `DataResponse` will be published. `.main` by default.
- /// - preprocessor: `DataPreprocessor` which filters the `Data` before serialization.
- /// `PassthroughPreprocessor()` by default.
- /// - decoder: `DataDecoder` instance used to decode response `Data`. `JSONDecoder()` by default.
- /// - emptyResponseCodes: `Set<Int>` of HTTP status codes for which empty responses are allowed. `[204, 205]` by
- /// default.
- /// - emptyRequestMethods: `Set<HTTPMethod>` of `HTTPMethod`s for which empty responses are allowed, regardless of
- /// status code. `[.head]` by default.
- ///
- /// - Returns: The `DataResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishDecodable<T: Decodable>(type: T.Type = T.self,
- queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = DecodableResponseSerializer<T>.defaultDataPreprocessor,
- decoder: DataDecoder = JSONDecoder(),
- emptyResponseCodes: Set<Int> = DecodableResponseSerializer<T>.defaultEmptyResponseCodes,
- emptyRequestMethods: Set<HTTPMethod> = DecodableResponseSerializer<T>.defaultEmptyRequestMethods) -> DataResponsePublisher<T> {
- publishResponse(using: DecodableResponseSerializer(dataPreprocessor: preprocessor,
- decoder: decoder,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyRequestMethods),
- on: queue)
- }
- /// Creates a `DataResponsePublisher` for this instance which does not serialize the response before publishing.
- ///
- /// - queue: `DispatchQueue` on which the `DataResponse` will be published. `.main` by default.
- ///
- /// - Returns: The `DataResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishUnserialized(queue: DispatchQueue = .main) -> DataResponsePublisher<Data?> {
- DataResponsePublisher(self, queue: queue)
- }
- }
- // A Combine `Publisher` that publishes a sequence of `Stream<Value, AFError>` values received by the provided `DataStreamRequest`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public struct DataStreamPublisher<Value>: Publisher {
- public typealias Output = DataStreamRequest.Stream<Value, AFError>
- public typealias Failure = Never
- private typealias Handler = (@escaping DataStreamRequest.Handler<Value, AFError>) -> DataStreamRequest
- private let request: DataStreamRequest
- private let streamHandler: Handler
- /// Creates an instance which will serialize responses using the provided `DataStreamSerializer`.
- ///
- /// - Parameters:
- /// - request: `DataStreamRequest` for which to publish the response.
- /// - queue: `DispatchQueue` on which the `Stream<Value, AFError>` values will be published. `.main` by
- /// default.
- /// - serializer: `DataStreamSerializer` used to produce the published `Stream<Value, AFError>` values.
- public init<Serializer: DataStreamSerializer>(_ request: DataStreamRequest, queue: DispatchQueue, serializer: Serializer)
- where Value == Serializer.SerializedObject {
- self.request = request
- streamHandler = { request.responseStream(using: serializer, on: queue, stream: $0) }
- }
- /// Publishes only the `Result` of the `DataStreamRequest.Stream`'s `Event`s.
- ///
- /// - Returns: The `AnyPublisher` publishing the `Result<Value, AFError>` value.
- public func result() -> AnyPublisher<Result<Value, AFError>, Never> {
- compactMap { stream in
- switch stream.event {
- case let .stream(result):
- return result
- // If the stream has completed with an error, send the error value downstream as a `.failure`.
- case let .complete(completion):
- return completion.error.map(Result.failure)
- }
- }
- .eraseToAnyPublisher()
- }
- /// Publishes the streamed values of the `DataStreamRequest.Stream` as a sequence of `Value` or fail with the
- /// `AFError` instance.
- ///
- /// - Returns: The `AnyPublisher<Value, AFError>` publishing the stream.
- public func value() -> AnyPublisher<Value, AFError> {
- result().setFailureType(to: AFError.self).flatMap(\.publisher).eraseToAnyPublisher()
- }
- public func receive<S>(subscriber: S) where S: Subscriber, DataStreamPublisher.Failure == S.Failure, DataStreamPublisher.Output == S.Input {
- subscriber.receive(subscription: Inner(request: request,
- streamHandler: streamHandler,
- downstream: subscriber))
- }
- private final class Inner<Downstream: Subscriber>: Subscription
- where Downstream.Input == Output {
- typealias Failure = Downstream.Failure
- @Protected
- private var downstream: Downstream?
- private let request: DataStreamRequest
- private let streamHandler: Handler
- init(request: DataStreamRequest, streamHandler: @escaping Handler, downstream: Downstream) {
- self.request = request
- self.streamHandler = streamHandler
- self.downstream = downstream
- }
- func request(_ demand: Subscribers.Demand) {
- assert(demand > 0)
- guard let downstream = downstream else { return }
- self.downstream = nil
- streamHandler { stream in
- _ = downstream.receive(stream)
- if case .complete = stream.event {
- downstream.receive(completion: .finished)
- }
- }.resume()
- }
- func cancel() {
- request.cancel()
- downstream = nil
- }
- }
- }
- extension DataStreamRequest {
- /// Creates a `DataStreamPublisher` for this instance using the given `DataStreamSerializer` and `DispatchQueue`.
- ///
- /// - Parameters:
- /// - serializer: `DataStreamSerializer` used to serialize the streamed `Data`.
- /// - queue: `DispatchQueue` on which the `DataRequest.Stream` values will be published. `.main` by default.
- /// - Returns: The `DataStreamPublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishStream<Serializer: DataStreamSerializer>(using serializer: Serializer,
- on queue: DispatchQueue = .main) -> DataStreamPublisher<Serializer.SerializedObject> {
- DataStreamPublisher(self, queue: queue, serializer: serializer)
- }
- /// Creates a `DataStreamPublisher` for this instance which uses a `PassthroughStreamSerializer` to stream `Data`
- /// unserialized.
- ///
- /// - Parameters:
- /// - queue: `DispatchQueue` on which the `DataRequest.Stream` values will be published. `.main` by default.
- /// - Returns: The `DataStreamPublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishData(queue: DispatchQueue = .main) -> DataStreamPublisher<Data> {
- publishStream(using: PassthroughStreamSerializer(), on: queue)
- }
- /// Creates a `DataStreamPublisher` for this instance which uses a `StringStreamSerializer` to serialize stream
- /// `Data` values into `String` values.
- ///
- /// - Parameters:
- /// - queue: `DispatchQueue` on which the `DataRequest.Stream` values will be published. `.main` by default.
- /// - Returns: The `DataStreamPublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishString(queue: DispatchQueue = .main) -> DataStreamPublisher<String> {
- publishStream(using: StringStreamSerializer(), on: queue)
- }
- /// Creates a `DataStreamPublisher` for this instance which uses a `DecodableStreamSerializer` with the provided
- /// parameters to serialize stream `Data` values into the provided type.
- ///
- /// - Parameters:
- /// - type: `Decodable` type to which to decode stream `Data`. Inferred from the context by default.
- /// - queue: `DispatchQueue` on which the `DataRequest.Stream` values will be published. `.main` by default.
- /// - decoder: `DataDecoder` instance used to decode stream `Data`. `JSONDecoder()` by default.
- /// - preprocessor: `DataPreprocessor` which filters incoming stream `Data` before serialization.
- /// `PassthroughPreprocessor()` by default.
- /// - Returns: The `DataStreamPublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishDecodable<T: Decodable>(type: T.Type = T.self,
- queue: DispatchQueue = .main,
- decoder: DataDecoder = JSONDecoder(),
- preprocessor: DataPreprocessor = PassthroughPreprocessor()) -> DataStreamPublisher<T> {
- publishStream(using: DecodableStreamSerializer(decoder: decoder,
- dataPreprocessor: preprocessor),
- on: queue)
- }
- }
- /// A Combine `Publisher` that publishes the `DownloadResponse<Value, AFError>` of the provided `DownloadRequest`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public struct DownloadResponsePublisher<Value>: Publisher {
- public typealias Output = DownloadResponse<Value, AFError>
- public typealias Failure = Never
- private typealias Handler = (@escaping (_ response: DownloadResponse<Value, AFError>) -> Void) -> DownloadRequest
- private let request: DownloadRequest
- private let responseHandler: Handler
- /// Creates an instance which will serialize responses using the provided `ResponseSerializer`.
- ///
- /// - Parameters:
- /// - request: `DownloadRequest` for which to publish the response.
- /// - queue: `DispatchQueue` on which the `DownloadResponse` value will be published. `.main` by default.
- /// - serializer: `ResponseSerializer` used to produce the published `DownloadResponse`.
- public init<Serializer: ResponseSerializer>(_ request: DownloadRequest, queue: DispatchQueue, serializer: Serializer)
- where Value == Serializer.SerializedObject {
- self.request = request
- responseHandler = { request.response(queue: queue, responseSerializer: serializer, completionHandler: $0) }
- }
- /// Creates an instance which will serialize responses using the provided `DownloadResponseSerializerProtocol` value.
- ///
- /// - Parameters:
- /// - request: `DownloadRequest` for which to publish the response.
- /// - queue: `DispatchQueue` on which the `DataResponse` value will be published. `.main` by default.
- /// - serializer: `DownloadResponseSerializerProtocol` used to produce the published `DownloadResponse`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public init<Serializer: DownloadResponseSerializerProtocol>(_ request: DownloadRequest,
- queue: DispatchQueue,
- serializer: Serializer)
- where Value == Serializer.SerializedObject {
- self.request = request
- responseHandler = { request.response(queue: queue, responseSerializer: serializer, completionHandler: $0) }
- }
- /// Publishes only the `Result` of the `DownloadResponse` value.
- ///
- /// - Returns: The `AnyPublisher` publishing the `Result<Value, AFError>` value.
- public func result() -> AnyPublisher<Result<Value, AFError>, Never> {
- map(\.result).eraseToAnyPublisher()
- }
- /// Publishes the `Result` of the `DownloadResponse` as a single `Value` or fail with the `AFError` instance.
- ///
- /// - Returns: The `AnyPublisher<Value, AFError>` publishing the stream.
- public func value() -> AnyPublisher<Value, AFError> {
- setFailureType(to: AFError.self).flatMap(\.result.publisher).eraseToAnyPublisher()
- }
- public func receive<S>(subscriber: S) where S: Subscriber, DownloadResponsePublisher.Failure == S.Failure, DownloadResponsePublisher.Output == S.Input {
- subscriber.receive(subscription: Inner(request: request,
- responseHandler: responseHandler,
- downstream: subscriber))
- }
- private final class Inner<Downstream: Subscriber>: Subscription
- where Downstream.Input == Output {
- typealias Failure = Downstream.Failure
- @Protected
- private var downstream: Downstream?
- private let request: DownloadRequest
- private let responseHandler: Handler
- init(request: DownloadRequest, responseHandler: @escaping Handler, downstream: Downstream) {
- self.request = request
- self.responseHandler = responseHandler
- self.downstream = downstream
- }
- func request(_ demand: Subscribers.Demand) {
- assert(demand > 0)
- guard let downstream = downstream else { return }
- self.downstream = nil
- responseHandler { response in
- _ = downstream.receive(response)
- downstream.receive(completion: .finished)
- }.resume()
- }
- func cancel() {
- request.cancel()
- downstream = nil
- }
- }
- }
- extension DownloadRequest {
- /// Creates a `DownloadResponsePublisher` for this instance using the given `ResponseSerializer` and `DispatchQueue`.
- ///
- /// - Parameters:
- /// - serializer: `ResponseSerializer` used to serialize the response `Data` from disk.
- /// - queue: `DispatchQueue` on which the `DownloadResponse` will be published.`.main` by default.
- ///
- /// - Returns: The `DownloadResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishResponse<Serializer: ResponseSerializer, T>(using serializer: Serializer, on queue: DispatchQueue = .main) -> DownloadResponsePublisher<T>
- where Serializer.SerializedObject == T {
- DownloadResponsePublisher(self, queue: queue, serializer: serializer)
- }
- /// Creates a `DownloadResponsePublisher` for this instance using the given `DownloadResponseSerializerProtocol` and
- /// `DispatchQueue`.
- ///
- /// - Parameters:
- /// - serializer: `DownloadResponseSerializer` used to serialize the response `Data` from disk.
- /// - queue: `DispatchQueue` on which the `DownloadResponse` will be published.`.main` by default.
- ///
- /// - Returns: The `DownloadResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishResponse<Serializer: DownloadResponseSerializerProtocol, T>(using serializer: Serializer, on queue: DispatchQueue = .main) -> DownloadResponsePublisher<T>
- where Serializer.SerializedObject == T {
- DownloadResponsePublisher(self, queue: queue, serializer: serializer)
- }
- /// Creates a `DownloadResponsePublisher` for this instance and uses a `URLResponseSerializer` to serialize the
- /// response.
- ///
- /// - Parameter queue: `DispatchQueue` on which the `DownloadResponse` will be published. `.main` by default.
- ///
- /// - Returns: The `DownloadResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishURL(queue: DispatchQueue = .main) -> DownloadResponsePublisher<URL> {
- publishResponse(using: URLResponseSerializer(), on: queue)
- }
- /// Creates a `DownloadResponsePublisher` for this instance and uses a `DataResponseSerializer` to serialize the
- /// response.
- ///
- /// - Parameters:
- /// - queue: `DispatchQueue` on which the `DownloadResponse` will be published. `.main` by default.
- /// - preprocessor: `DataPreprocessor` which filters the `Data` before serialization. `PassthroughPreprocessor()`
- /// by default.
- /// - emptyResponseCodes: `Set<Int>` of HTTP status codes for which empty responses are allowed. `[204, 205]` by
- /// default.
- /// - emptyRequestMethods: `Set<HTTPMethod>` of `HTTPMethod`s for which empty responses are allowed, regardless of
- /// status code. `[.head]` by default.
- ///
- /// - Returns: The `DownloadResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishData(queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = DataResponseSerializer.defaultDataPreprocessor,
- emptyResponseCodes: Set<Int> = DataResponseSerializer.defaultEmptyResponseCodes,
- emptyRequestMethods: Set<HTTPMethod> = DataResponseSerializer.defaultEmptyRequestMethods) -> DownloadResponsePublisher<Data> {
- publishResponse(using: DataResponseSerializer(dataPreprocessor: preprocessor,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyRequestMethods),
- on: queue)
- }
- /// Creates a `DownloadResponsePublisher` for this instance and uses a `StringResponseSerializer` to serialize the
- /// response.
- ///
- /// - Parameters:
- /// - queue: `DispatchQueue` on which the `DataResponse` will be published. `.main` by default.
- /// - preprocessor: `DataPreprocessor` which filters the `Data` before serialization. `PassthroughPreprocessor()`
- /// by default.
- /// - encoding: `String.Encoding` to parse the response. `nil` by default, in which case the encoding
- /// will be determined by the server response, falling back to the default HTTP character
- /// set, `ISO-8859-1`.
- /// - emptyResponseCodes: `Set<Int>` of HTTP status codes for which empty responses are allowed. `[204, 205]` by
- /// default.
- /// - emptyRequestMethods: `Set<HTTPMethod>` of `HTTPMethod`s for which empty responses are allowed, regardless of
- /// status code. `[.head]` by default.
- ///
- /// - Returns: The `DownloadResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishString(queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = StringResponseSerializer.defaultDataPreprocessor,
- encoding: String.Encoding? = nil,
- emptyResponseCodes: Set<Int> = StringResponseSerializer.defaultEmptyResponseCodes,
- emptyRequestMethods: Set<HTTPMethod> = StringResponseSerializer.defaultEmptyRequestMethods) -> DownloadResponsePublisher<String> {
- publishResponse(using: StringResponseSerializer(dataPreprocessor: preprocessor,
- encoding: encoding,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyRequestMethods),
- on: queue)
- }
- @_disfavoredOverload
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- @available(*, deprecated, message: "Renamed publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyRequestMethods).")
- public func publishDecodable<T: Decodable>(type: T.Type = T.self,
- queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = DecodableResponseSerializer<T>.defaultDataPreprocessor,
- decoder: DataDecoder = JSONDecoder(),
- emptyResponseCodes: Set<Int> = DecodableResponseSerializer<T>.defaultEmptyResponseCodes,
- emptyResponseMethods: Set<HTTPMethod> = DecodableResponseSerializer<T>.defaultEmptyRequestMethods) -> DownloadResponsePublisher<T> {
- publishResponse(using: DecodableResponseSerializer(dataPreprocessor: preprocessor,
- decoder: decoder,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyResponseMethods),
- on: queue)
- }
- /// Creates a `DownloadResponsePublisher` for this instance and uses a `DecodableResponseSerializer` to serialize
- /// the response.
- ///
- /// - Parameters:
- /// - type: `Decodable` type to which to decode response `Data`. Inferred from the context by default.
- /// - queue: `DispatchQueue` on which the `DataResponse` will be published. `.main` by default.
- /// - preprocessor: `DataPreprocessor` which filters the `Data` before serialization.
- /// `PassthroughPreprocessor()` by default.
- /// - decoder: `DataDecoder` instance used to decode response `Data`. `JSONDecoder()` by default.
- /// - emptyResponseCodes: `Set<Int>` of HTTP status codes for which empty responses are allowed. `[204, 205]` by
- /// default.
- /// - emptyRequestMethods: `Set<HTTPMethod>` of `HTTPMethod`s for which empty responses are allowed, regardless
- /// of status code. `[.head]` by default.
- ///
- /// - Returns: The `DownloadResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishDecodable<T: Decodable>(type: T.Type = T.self,
- queue: DispatchQueue = .main,
- preprocessor: DataPreprocessor = DecodableResponseSerializer<T>.defaultDataPreprocessor,
- decoder: DataDecoder = JSONDecoder(),
- emptyResponseCodes: Set<Int> = DecodableResponseSerializer<T>.defaultEmptyResponseCodes,
- emptyRequestMethods: Set<HTTPMethod> = DecodableResponseSerializer<T>.defaultEmptyRequestMethods) -> DownloadResponsePublisher<T> {
- publishResponse(using: DecodableResponseSerializer(dataPreprocessor: preprocessor,
- decoder: decoder,
- emptyResponseCodes: emptyResponseCodes,
- emptyRequestMethods: emptyRequestMethods),
- on: queue)
- }
- }
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- extension DownloadResponsePublisher where Value == URL? {
- /// Creates an instance which publishes a `DownloadResponse<URL?, AFError>` value without serialization.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public init(_ request: DownloadRequest, queue: DispatchQueue) {
- self.request = request
- responseHandler = { request.response(queue: queue, completionHandler: $0) }
- }
- }
- extension DownloadRequest {
- /// Creates a `DownloadResponsePublisher` for this instance which does not serialize the response before publishing.
- ///
- /// - Parameter queue: `DispatchQueue` on which the `DownloadResponse` will be published. `.main` by default.
- ///
- /// - Returns: The `DownloadResponsePublisher`.
- @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
- public func publishUnserialized(on queue: DispatchQueue = .main) -> DownloadResponsePublisher<URL?> {
- DownloadResponsePublisher(self, queue: queue)
- }
- }
- #endif
|