Back to Alamofire

DownloadResponsePublisher

docs/Structs/DownloadResponsePublisher.html

5.12.03.7 KB
Original Source

DownloadResponsePublisher

@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
public struct DownloadResponsePublisher<Value> : Publisher where Value : Sendable

A Combine Publisher that publishes the DownloadResponse<Value, AFError> of the provided DownloadRequest.

`

                Output
                `

Declaration

Swift

public typealias Output = DownloadResponse<Value, AFError>

`

                Failure
                `

Declaration

Swift

public typealias Failure = Never

`

                init(_:queue:serializer:)
                `

Creates an instance which will serialize responses using the provided ResponseSerializer.

Declaration

Swift

public init<Serializer: ResponseSerializer>(_ request: DownloadRequest, queue: DispatchQueue, serializer: Serializer)
    where Value == Serializer.SerializedObject

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.

|

`

                init(_:queue:serializer:)
                `

Creates an instance which will serialize responses using the provided DownloadResponseSerializerProtocol value.

Declaration

Swift

@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
public init<Serializer: DownloadResponseSerializerProtocol>(_ request: DownloadRequest,
                                                            queue: DispatchQueue,
                                                            serializer: Serializer)
    where Value == Serializer.SerializedObject

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.

|

`

                result()
                `

Publishes only the Result of the DownloadResponse value.

Declaration

Swift

public func result() -> AnyPublisher<Result<Value, AFError>, Never>

Return Value

The AnyPublisher publishing the Result<Value, AFError> value.

`

                value()
                `

Publishes the Result of the DownloadResponse as a single Value or fail with the AFError instance.

Declaration

Swift

public func value() -> AnyPublisher<Value, AFError>

Return Value

The AnyPublisher<Value, AFError> publishing the stream.

`

                receive(subscriber:)
                `

Declaration

Swift

public func receive<S>(subscriber: S) where S : Subscriber, S : Sendable, S.Failure == Never, S.Input == DownloadResponse<Value, AFError>

Available where Value == URL?

`

                init(_:queue:)
                `

Creates an instance which publishes a DownloadResponse<URL?, AFError> value without serialization.

Declaration

Swift

@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
public init(_ request: DownloadRequest, queue: DispatchQueue)