DataResponse
public struct DataResponse<Value>
Used to store all data associated with a serialized response of a data or upload request.
-
The URL request sent to the server.
Declaration
Swift
public let request: URLRequest?
-
The server’s response to the URL request.
Declaration
Swift
public let response: HTTPURLResponse?
-
The data returned by the server.
Declaration
Swift
public let data: Data?
-
The final metrics of the response.
Declaration
Swift
public let metrics: URLSessionTaskMetrics?
-
The time taken to serialize the response.
Declaration
Swift
public let serializationDuration: TimeInterval
-
The result of response serialization.
Declaration
Swift
public let result: AFResult<Value>
-
Returns the associated value of the result if it is a success,
nil
otherwise.Declaration
Swift
public var value: Value? { get }
-
Returns the associated error value if the result if it is a failure,
nil
otherwise.Declaration
Swift
public var error: Error? { get }
-
Creates a
DataResponse
instance with the specified parameters derviced from the response serialization.Declaration
Swift
public init(request: URLRequest?, response: HTTPURLResponse?, data: Data?, metrics: URLSessionTaskMetrics?, serializationDuration: TimeInterval, result: AFResult<Value>)
Parameters
request
The
URLRequest
sent to the server.response
The
HTTPURLResponse
from the server.data
The
Data
returned by the server.metrics
The
URLSessionTaskMetrics
of the serialized response.serializationDuration
The duration taken by serialization.
result
The
AFResult
of response serialization.
-
The textual representation used when written to an output stream, which includes whether the result was a success or failure.
Declaration
Swift
public var description: String { get }
-
The debug textual representation used when written to an output stream, which includes the URL request, the URL response, the server data, the duration of the network and serializatino actions, and the response serialization result.
Declaration
Swift
public var debugDescription: String { get }
-
Evaluates the specified closure when the result of this
DataResponse
is a success, passing the unwrapped result value as a parameter.Use the
map
method with a closure that does not throw. For example:let possibleData: DataResponse<Data> = ... let possibleInt = possibleData.map { $0.count }
Declaration
Swift
public func map<T>(_ transform: (Value) -> T) -> DataResponse<T>
Parameters
transform
A closure that takes the success value of the instance’s result.
Return Value
A
DataResponse
whose result wraps the value returned by the given closure. If this instance’s result is a failure, returns a response wrapping the same failure. -
Evaluates the given closure when the result of this
DataResponse
is a success, passing the unwrapped result value as a parameter.Use the
flatMap
method with a closure that may throw an error. For example:let possibleData: DataResponse<Data> = ... let possibleObject = possibleData.flatMap { try JSONSerialization.jsonObject(with: $0) }
Declaration
Swift
public func flatMap<T>(_ transform: (Value) throws -> T) -> DataResponse<T>
Parameters
transform
A closure that takes the success value of the instance’s result.
Return Value
A success or failure
DataResponse
depending on the result of the given closure. If this instance’s result is a failure, returns the same failure. -
Evaluates the specified closure when the
DataResponse
is a failure, passing the unwrapped error as a parameter.Use the
mapError
function with a closure that does not throw. For example:let possibleData: DataResponse<Data> = ... let withMyError = possibleData.mapError { MyError.error($0) }
Declaration
Swift
public func mapError<E>(_ transform: (Error) -> E) -> DataResponse where E : Error
Parameters
transform
A closure that takes the error of the instance.
Return Value
A
DataResponse
instance containing the result of the transform. -
Evaluates the specified closure when the
DataResponse
is a failure, passing the unwrapped error as a parameter.Use the
flatMapError
function with a closure that may throw an error. For example:let possibleData: DataResponse<Data> = ... let possibleObject = possibleData.flatMapError { try someFailableFunction(taking: $0) }
Declaration
Swift
public func flatMapError<E>(_ transform: (Error) throws -> E) -> DataResponse where E : Error
Parameters
transform
A throwing closure that takes the error of the instance.
Return Value
A
DataResponse
instance containing the result of the transform.