StringResponseSerializer
public final class StringResponseSerializer : ResponseSerializer
A ResponseSerializer
that decodes the response data as a String
. By default, a request returning nil
or no
data is considered an error. However, if the response is has a status code valid for empty responses (204
, 205
),
then an empty String
is returned.
-
Optional string encoding used to validate the response.
Declaration
Swift
public let encoding: String.Encoding?
-
HTTP response codes for which empty responses are allowed.
Declaration
Swift
public let emptyResponseCodes: Set<Int>
-
HTTP request methods for which empty responses are allowed.
Declaration
Swift
public let emptyRequestMethods: Set<HTTPMethod>
-
Creates an instance with the provided values.
Declaration
Swift
public init(encoding: String.Encoding? = nil, emptyResponseCodes: Set<Int> = StringResponseSerializer.defaultEmptyResponseCodes, emptyRequestMethods: Set<HTTPMethod> = StringResponseSerializer.defaultEmptyRequestMethods)
Parameters
encoding
A string encoding. Defaults to
nil
, in which case the encoding will be determined from the server response, falling back to the default HTTP character set,ISO-8859-1
.emptyResponseCodes
The HTTP response codes for which empty responses are allowed.
[204, 205]
by default.emptyRequestMethods
The HTTP request methods for which empty responses are allowed.
[.head]
by default. -
Declaration
Swift
public func serialize(request: URLRequest?, response: HTTPURLResponse?, data: Data?, error: Error?) throws -> String