Structures
The following structures are available globally.
-
See moreDataStreamSerializerwhich uses the providedDataPreprocessorandDataDecoderto serialize the incomingData.Declaration
Swift
public struct DecodableStreamSerializer<T> : DataStreamSerializer where T : Decodable, T : Sendable -
See moreDataStreamSerializerwhich performs no serialization on incomingData.Declaration
Swift
public struct PassthroughStreamSerializer : DataStreamSerializer -
See moreDataStreamSerializerwhich serializes incoming streamDataintoUTF8-decodedStringvalues.Declaration
Swift
public struct StringStreamSerializer : DataStreamSerializer -
An order-preserving and case-insensitive representation of HTTP headers.
See moreDeclaration
Swift
public struct HTTPHeaders : Equatable, Hashable, Sendableextension HTTPHeaders: ExpressibleByDictionaryLiteralextension HTTPHeaders: ExpressibleByArrayLiteralextension HTTPHeaders: Sequenceextension HTTPHeaders: Collectionextension HTTPHeaders: CustomStringConvertible
-
A representation of a single HTTP header’s name / value pair.
See moreDeclaration
Swift
public struct HTTPHeader : Equatable, Hashable, Sendableextension HTTPHeader: CustomStringConvertible -
Type representing HTTP methods. Raw
Stringvalue is stored and compared case-sensitively, soHTTPMethod.get != HTTPMethod(rawValue: "get").See https://tools.ietf.org/html/rfc7231#section-4.3
See moreDeclaration
Swift
public struct HTTPMethod : RawRepresentable, Equatable, Hashable, Sendable
-
Creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP body of the URL request. Whether the query string is set or appended to any existing URL query string or set as the HTTP body depends on the destination of the encoding.
The
Content-TypeHTTP header field of an encoded request with HTTP body is set toapplication/x-www-form-urlencoded; charset=utf-8.There is no published specification for how to encode collection types. By default the convention of appending
[]to the key for array values (foo[]=1&foo[]=2), and appending the key surrounded by square brackets for nested dictionary values (foo[bar]=baz) is used. Optionally,ArrayEncodingcan be used to omit the square brackets appended to array keys.
See moreBoolEncodingcan be used to configure how boolean values are encoded. The default behavior is to encodetrueas 1 andfalseas 0.Declaration
Swift
public struct URLEncoding : ParameterEncoding -
Uses
See moreJSONSerializationto create a JSON representation of the parameters object, which is set as the body of the request. TheContent-TypeHTTP header field of an encoded request is set toapplication/json.Declaration
Swift
public struct JSONEncoding : ParameterEncoding -
Type used to store all values associated with a serialized response of a
See moreDataRequestorUploadRequest.Declaration
Swift
public struct DataResponse<Success, Failure> : Sendable where Success : Sendable, Failure : Errorextension DataResponse: CustomStringConvertible, CustomDebugStringConvertible -
Used to store all data associated with a serialized response of a download request.
See moreDeclaration
Swift
public struct DownloadResponse<Success, Failure> : Sendable where Success : Sendable, Failure : Errorextension DownloadResponse: CustomStringConvertible, CustomDebugStringConvertible -
Undocumented
See moreDeclaration
Swift
public struct DecodableWebSocketMessageDecoder<Value> : WebSocketMessageSerializer where Value : Decodable, Value : Sendable -
Type that acts as a generic extension point for all
See moreAlamofireExtendedtypes.Declaration
Swift
public struct AlamofireExtension<ExtendedType> -
See moreResponseCacheris a convenienceCachedResponseHandlermaking it easy to cache, not cache, or modify a cached response.Declaration
-
A Combine
See morePublisherthat publishes theDataResponse<Value, AFError>of the providedDataRequest.Declaration
Swift
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *) public struct DataResponsePublisher<Value> : Publisher where Value : Sendable -
Undocumented
See moreDeclaration
Swift
public struct DataStreamPublisher<Value> : Publisher where Value : Sendable -
A Combine
See morePublisherthat publishes theDownloadResponse<Value, AFError>of the providedDownloadRequest.Declaration
Swift
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *) public struct DownloadResponsePublisher<Value> : Publisher where Value : Sendable
-
Value used to
See moreawaitaDataResponseand associated values.Declaration
Swift
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) public struct DataTask<Value> : Sendable where Value : Sendable
-
Value used to
See moreawaitaDownloadResponseand associated values.Declaration
Swift
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) public struct DownloadTask<Value> : Sendable where Value : Sendable
-
Undocumented
See moreDeclaration
Swift
public struct DataStreamTask : Sendable
-
An asynchronous sequence generated from an underlying
See moreAsyncStream. Only produced by Alamofire.Declaration
Swift
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) public struct StreamOf<Element> : AsyncSequence
-
See moreRedirectoris a convenienceRedirectHandlermaking it easy to follow, not follow, or modify a redirect.Declaration
-
RequestAdapterwhich compresses outgoingURLRequestbodies using thedeflateContent-Encodingand adds the appropriate header.See moreNote
Most requests to most APIs are small and so would only be slowed down by applying this adapter. Measure the size of your request bodies and the performance impact of using this adapter before use. Using this adapter with already compressed data, such as images, will, at best, have no effect. Additionally, body compression is a synchronous operation, so measuring the performance impact may be important to determine whether you want to use a dedicatedrequestQueuein yourSessioninstance. Finally, not all servers support request compression, so test with all of your server configurations before deploying.Declaration
Swift
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) public struct DeflateRequestCompressor : Sendable, RequestInterceptor -
Stores all state associated with a
See moreURLRequestbeing adapted.Declaration
Swift
public struct RequestAdapterState : Sendable -
See moreDataPreprocessorthat returns passedDatawithout any transform.Declaration
Swift
public struct PassthroughPreprocessor : DataPreprocessor -
See moreDataPreprocessorthat trims Google’s typical)]}',\nXSSI JSON header.Declaration
Swift
public struct GoogleXSSIPreprocessor : DataPreprocessor
-
A
See moreDownloadResponseSerializerProtocolthat performs onlyErrorchecking and ensures that a downloadedfileURLis present.Declaration
Swift
public struct URLResponseSerializer : DownloadResponseSerializerProtocol
-
Type representing an empty value. Use
See moreEmpty.valueto get the static instance.Declaration
View on GitHub
Install in Dash
Structures Reference