| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <title>Structures Reference</title>
- <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
- <link rel="stylesheet" type="text/css" href="css/highlight.css" />
- <meta charset="utf-8">
- <script src="js/jquery.min.js" defer></script>
- <script src="js/jazzy.js" defer></script>
-
- <script src="js/lunr.min.js" defer></script>
- <script src="js/typeahead.jquery.js" defer></script>
- <script src="js/jazzy.search.js" defer></script>
- </head>
- <body>
- <a name="//apple_ref/swift/Section/Structures" class="dashAnchor"></a>
- <a title="Structures Reference"></a>
- <header class="header">
- <p class="header-col header-col--primary">
- <a class="header-link" href="index.html">
- Alamofire 5.7.1 Docs
- </a>
- (97% documented)
- </p>
-
- <div class="header-col--secondary">
- <form role="search" action="search.json">
- <input type="text" placeholder="Search documentation" data-typeahead>
- </form>
- </div>
-
- <p class="header-col header-col--secondary">
- <a class="header-link" href="https://github.com/Alamofire/Alamofire">
- <img class="header-icon" src="img/gh.png" alt="GitHub"/>
- View on GitHub
- </a>
- </p>
-
- <p class="header-col header-col--secondary">
- <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
- <img class="header-icon" src="img/dash.png" alt="Dash"/>
- Install in Dash
- </a>
- </p>
- </header>
- <p class="breadcrumbs">
- <a class="breadcrumb" href="index.html">Alamofire Reference</a>
- <img class="carat" src="img/carat.png" alt=""/>
- Structures Reference
- </p>
- <div class="content-wrapper">
- <nav class="navigation">
- <ul class="nav-groups">
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="Classes.html">Classes</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/Adapter.html">Adapter</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/AlamofireNotifications.html">AlamofireNotifications</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DataRequest.html">DataRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DataResponseSerializer.html">DataResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DataStreamRequest.html">DataStreamRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DataStreamRequest/Stream.html">– Stream</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DataStreamRequest/Event.html">– Event</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DataStreamRequest/Completion.html">– Completion</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DownloadRequest.html">DownloadRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DownloadRequest/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/Interceptor.html">Interceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/MultipartFormData.html">MultipartFormData</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/Request.html">Request</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/Request/State.html">– State</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/Retrier.html">Retrier</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/RetryPolicy.html">RetryPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/RevocationTrustEvaluator/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/ServerTrustManager.html">ServerTrustManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/Session.html">Session</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/StringResponseSerializer.html">StringResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormEncoder/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Classes/UploadRequest/Uploadable.html">– Uploadable</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="Global%20Variables.html">Global Variables</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/AuthenticationError.html">AuthenticationError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Enums/RetryResult.html">RetryResult</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/Array.html">Array</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/CharacterSet.html">CharacterSet</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/Error.html">Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/c:@T@OSStatus">OSStatus</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/String.html">String</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/AlamofireExtended.html">AlamofireExtended</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/Authenticator.html">Authenticator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/DataDecoder.html">DataDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/DataPreprocessor.html">DataPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/EmptyResponse.html">EmptyResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/EventMonitor.html">EventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/ParameterEncoder.html">ParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/RedirectHandler.html">RedirectHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/RequestDelegate.html">RequestDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/RequestInterceptor.html">RequestInterceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/ResponseSerializer.html">ResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Protocols/UploadableConvertible.html">UploadableConvertible</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="Structs.html">Structures</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/AlamofireExtension.html">AlamofireExtension</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DataResponsePublisher.html">DataResponsePublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DataStreamPublisher.html">DataStreamPublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DataStreamTask.html">DataStreamTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DataTask.html">DataTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/DownloadTask.html">DownloadTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/Empty.html">Empty</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/HTTPHeader.html">HTTPHeader</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/HTTPHeaders.html">HTTPHeaders</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/HTTPMethod.html">HTTPMethod</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/JSONEncoding/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/Redirector.html">Redirector</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/Redirector/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/RequestAdapterState.html">RequestAdapterState</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/ResponseCacher.html">ResponseCacher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/ResponseCacher/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/StreamOf.html">StreamOf</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/StreamOf/Iterator.html">– Iterator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/StringStreamSerializer.html">StringStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Structs/URLResponseSerializer.html">URLResponseSerializer</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section class="section">
- <div class="section-content top-matter">
- <h1>Structures</h1>
- <p>The following structures are available globally.</p>
- </div>
- </section>
- <section class="section">
- <div class="section-content">
- <div class="task-group">
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire0A9ExtensionV"></a>
- <a name="//apple_ref/swift/Struct/AlamofireExtension" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire0A9ExtensionV">AlamofireExtension</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Type that acts as a generic extension point for all <code><a href="Protocols/AlamofireExtended.html">AlamofireExtended</a></code> types.</p>
- <a href="Structs/AlamofireExtension.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">AlamofireExtension</span><span class="o"><</span><span class="kt">ExtendedType</span><span class="o">></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14ResponseCacherV"></a>
- <a name="//apple_ref/swift/Struct/ResponseCacher" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14ResponseCacherV">ResponseCacher</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>ResponseCacher</code> is a convenience <code><a href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> making it easy to cache, not cache, or modify a cached
- response.</p>
- <a href="Structs/ResponseCacher.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ResponseCacher</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">ResponseCacher</span><span class="p">:</span> <span class="kt"><a href="Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DataRequest%20%2F%20UploadRequest"></a>
- <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/DataRequest%20%2F%20UploadRequest"></a>
- <h3 class="section-name"><span>DataRequest / UploadRequest</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire21DataResponsePublisherV"></a>
- <a name="//apple_ref/swift/Struct/DataResponsePublisher" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire21DataResponsePublisherV">DataResponsePublisher</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A Combine <code>Publisher</code> that publishes the <code>DataResponse<Value, AFError></code> of the provided <code><a href="Classes/DataRequest.html">DataRequest</a></code>.</p>
- <a href="Structs/DataResponsePublisher.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
- <span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataResponsePublisher</span><span class="o"><</span><span class="kt">Value</span><span class="o">></span> <span class="p">:</span> <span class="kt">Publisher</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire19DataStreamPublisherV"></a>
- <a name="//apple_ref/swift/Struct/DataStreamPublisher" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire19DataStreamPublisherV">DataStreamPublisher</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- <a href="Structs/DataStreamPublisher.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataStreamPublisher</span><span class="o"><</span><span class="kt">Value</span><span class="o">></span> <span class="p">:</span> <span class="kt">Publisher</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire25DownloadResponsePublisherV"></a>
- <a name="//apple_ref/swift/Struct/DownloadResponsePublisher" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire25DownloadResponsePublisherV">DownloadResponsePublisher</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A Combine <code>Publisher</code> that publishes the <code>DownloadResponse<Value, AFError></code> of the provided <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
- <a href="Structs/DownloadResponsePublisher.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
- <span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadResponsePublisher</span><span class="o"><</span><span class="kt">Value</span><span class="o">></span> <span class="p">:</span> <span class="kt">Publisher</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DataTask"></a>
- <a name="//apple_ref/swift/Section/DataTask" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/DataTask"></a>
- <h3 class="section-name"><span>DataTask</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire8DataTaskV"></a>
- <a name="//apple_ref/swift/Struct/DataTask" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire8DataTaskV">DataTask</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Value used to <code>await</code> a <code><a href="Structs/DataResponse.html">DataResponse</a></code> and associated values.</p>
- <a href="Structs/DataTask.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)</span>
- <span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataTask</span><span class="o"><</span><span class="kt">Value</span><span class="o">></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DownloadTask"></a>
- <a name="//apple_ref/swift/Section/DownloadTask" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/DownloadTask"></a>
- <h3 class="section-name"><span>DownloadTask</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire12DownloadTaskV"></a>
- <a name="//apple_ref/swift/Struct/DownloadTask" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire12DownloadTaskV">DownloadTask</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Value used to <code>await</code> a <code><a href="Structs/DownloadResponse.html">DownloadResponse</a></code> and associated values.</p>
- <a href="Structs/DownloadTask.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)</span>
- <span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadTask</span><span class="o"><</span><span class="kt">Value</span><span class="o">></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DataStreamTask"></a>
- <a name="//apple_ref/swift/Section/DataStreamTask" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/DataStreamTask"></a>
- <h3 class="section-name"><span>DataStreamTask</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14DataStreamTaskV"></a>
- <a name="//apple_ref/swift/Struct/DataStreamTask" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14DataStreamTaskV">DataStreamTask</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Undocumented</p>
- <a href="Structs/DataStreamTask.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataStreamTask</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire8StreamOfV"></a>
- <a name="//apple_ref/swift/Struct/StreamOf" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire8StreamOfV">StreamOf</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An asynchronous sequence generated from an underlying <code>AsyncStream</code>. Only produced by Alamofire.</p>
- <a href="Structs/StreamOf.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)</span>
- <span class="kd">public</span> <span class="kd">struct</span> <span class="kt">StreamOf</span><span class="o"><</span><span class="kt">Element</span><span class="o">></span> <span class="p">:</span> <span class="kt">AsyncSequence</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11HTTPHeadersV"></a>
- <a name="//apple_ref/swift/Struct/HTTPHeaders" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11HTTPHeadersV">HTTPHeaders</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>An order-preserving and case-insensitive representation of HTTP headers.</p>
- <a href="Structs/HTTPHeaders.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPHeaders</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">ExpressibleByDictionaryLiteral</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">ExpressibleByArrayLiteral</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">Sequence</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">Collection</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeaders</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/HTTPHeader"></a>
- <a name="//apple_ref/swift/Section/HTTPHeader" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/HTTPHeader"></a>
- <h3 class="section-name"><span>HTTPHeader</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire10HTTPHeaderV"></a>
- <a name="//apple_ref/swift/Struct/HTTPHeader" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire10HTTPHeaderV">HTTPHeader</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A representation of a single HTTP header’s name / value pair.</p>
- <a href="Structs/HTTPHeader.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPHeader</span> <span class="p">:</span> <span class="kt">Hashable</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">HTTPHeader</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire10HTTPMethodV"></a>
- <a name="//apple_ref/swift/Struct/HTTPMethod" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire10HTTPMethodV">HTTPMethod</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Type representing HTTP methods. Raw <code>String</code> value is stored and compared case-sensitively, so
- <code>HTTPMethod.get != HTTPMethod(rawValue: "get")</code>.</p>
- <p>See <a href="https://tools.ietf.org/html/rfc7231#section-4.3">https://tools.ietf.org/html/rfc7231#section-4.3</a></p>
- <a href="Structs/HTTPMethod.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">HTTPMethod</span> <span class="p">:</span> <span class="kt">RawRepresentable</span><span class="p">,</span> <span class="kt">Equatable</span><span class="p">,</span> <span class="kt">Hashable</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire11URLEncodingV"></a>
- <a name="//apple_ref/swift/Struct/URLEncoding" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire11URLEncodingV">URLEncoding</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>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.</p>
- <p>The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to
- <code>application/x-www-form-urlencoded; charset=utf-8</code>.</p>
- <p>There is no published specification for how to encode collection types. By default the convention of appending
- <code>[]</code> to the key for array values (<code>foo[]=1&foo[]=2</code>), and appending the key surrounded by square brackets for
- nested dictionary values (<code>foo[bar]=baz</code>) is used. Optionally, <code>ArrayEncoding</code> can be used to omit the
- square brackets appended to array keys.</p>
- <p><code>BoolEncoding</code> can be used to configure how boolean values are encoded. The default behavior is to encode
- <code>true</code> as 1 and <code>false</code> as 0.</p>
- <a href="Structs/URLEncoding.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">URLEncoding</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ParameterEncoding.html">ParameterEncoding</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire12JSONEncodingV"></a>
- <a name="//apple_ref/swift/Struct/JSONEncoding" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire12JSONEncodingV">JSONEncoding</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Uses <code>JSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the
- request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
- <a href="Structs/JSONEncoding.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">JSONEncoding</span> <span class="p">:</span> <span class="kt"><a href="Protocols/ParameterEncoding.html">ParameterEncoding</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire10RedirectorV"></a>
- <a name="//apple_ref/swift/Struct/Redirector" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire10RedirectorV">Redirector</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>Redirector</code> is a convenience <code><a href="Protocols/RedirectHandler.html">RedirectHandler</a></code> making it easy to follow, not follow, or modify a redirect.</p>
- <a href="Structs/Redirector.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Redirector</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Redirector</span><span class="p">:</span> <span class="kt"><a href="Protocols/RedirectHandler.html">RedirectHandler</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire24DeflateRequestCompressorV"></a>
- <a name="//apple_ref/swift/Struct/DeflateRequestCompressor" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire24DeflateRequestCompressorV">DeflateRequestCompressor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Protocols/RequestAdapter.html">RequestAdapter</a></code> which compresses outgoing <code>URLRequest</code> bodies using the <code>deflate</code> <code>Content-Encoding</code> and adds the
- appropriate header.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- 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 dedicated <code>requestQueue</code> in your <code><a href="Classes/Session.html">Session</a></code> instance. Finally, not all servers support request
- compression, so test with all of your server configurations before deploying.
- </div>
- <a href="Structs/DeflateRequestCompressor.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)</span>
- <span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DeflateRequestCompressor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/RequestInterceptor.html">RequestInterceptor</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire19RequestAdapterStateV"></a>
- <a name="//apple_ref/swift/Struct/RequestAdapterState" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire19RequestAdapterStateV">RequestAdapterState</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Stores all state associated with a <code>URLRequest</code> being adapted.</p>
- <a href="Structs/RequestAdapterState.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">RequestAdapterState</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire12DataResponseV"></a>
- <a name="//apple_ref/swift/Struct/DataResponse" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire12DataResponseV">DataResponse</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Type used to store all values associated with a serialized response of a <code><a href="Classes/DataRequest.html">DataRequest</a></code> or <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- <a href="Structs/DataResponse.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DataResponse</span><span class="o"><</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">></span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DataResponse</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire16DownloadResponseV"></a>
- <a name="//apple_ref/swift/Struct/DownloadResponse" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire16DownloadResponseV">DownloadResponse</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Used to store all data associated with a serialized response of a download request.</p>
- <a href="Structs/DownloadResponse.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadResponse</span><span class="o"><</span><span class="kt">Success</span><span class="p">,</span> <span class="kt">Failure</span><span class="o">></span> <span class="k">where</span> <span class="kt">Failure</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">DownloadResponse</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Protocols"></a>
- <a name="//apple_ref/swift/Section/Protocols" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Protocols"></a>
- <h3 class="section-name"><span>Protocols</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire23PassthroughPreprocessorV"></a>
- <a name="//apple_ref/swift/Struct/PassthroughPreprocessor" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire23PassthroughPreprocessorV">PassthroughPreprocessor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></code> that returns passed <code>Data</code> without any transform.</p>
- <a href="Structs/PassthroughPreprocessor.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">PassthroughPreprocessor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire22GoogleXSSIPreprocessorV"></a>
- <a name="//apple_ref/swift/Struct/GoogleXSSIPreprocessor" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire22GoogleXSSIPreprocessorV">GoogleXSSIPreprocessor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></code> that trims Google’s typical <code>)]}',\n</code> XSSI JSON header.</p>
- <a href="Structs/GoogleXSSIPreprocessor.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">GoogleXSSIPreprocessor</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/URL"></a>
- <a name="//apple_ref/swift/Section/URL" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/URL"></a>
- <h3 class="section-name"><span>URL</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire21URLResponseSerializerV"></a>
- <a name="//apple_ref/swift/Struct/URLResponseSerializer" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire21URLResponseSerializerV">URLResponseSerializer</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A <code><a href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></code> that performs only <code>Error</code> checking and ensures that a downloaded <code>fileURL</code>
- is present.</p>
- <a href="Structs/URLResponseSerializer.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">URLResponseSerializer</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Empty"></a>
- <a name="//apple_ref/swift/Section/Empty" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Empty"></a>
- <h3 class="section-name"><span>Empty</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire5EmptyV"></a>
- <a name="//apple_ref/swift/Struct/Empty" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire5EmptyV">Empty</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Type representing an empty value. Use <code><a href="Structs/Empty.html#/s:9Alamofire5EmptyV5valueACvpZ">Empty.value</a></code> to get the static instance.</p>
- <a href="Structs/Empty.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Empty</span> <span class="p">:</span> <span class="kt">Codable</span></code></pre>
- <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Empty</span><span class="p">:</span> <span class="kt"><a href="Protocols/EmptyResponse.html">EmptyResponse</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DataStreamRequest"></a>
- <a name="//apple_ref/swift/Section/DataStreamRequest" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/DataStreamRequest"></a>
- <h3 class="section-name"><span>DataStreamRequest</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire25DecodableStreamSerializerV"></a>
- <a name="//apple_ref/swift/Struct/DecodableStreamSerializer" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire25DecodableStreamSerializerV">DecodableStreamSerializer</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> which uses the provided <code><a href="Protocols/DataPreprocessor.html">DataPreprocessor</a></code> and <code><a href="Protocols/DataDecoder.html">DataDecoder</a></code> to serialize the incoming <code>Data</code>.</p>
- <a href="Structs/DecodableStreamSerializer.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DecodableStreamSerializer</span><span class="o"><</span><span class="kt">T</span><span class="o">></span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire27PassthroughStreamSerializerV"></a>
- <a name="//apple_ref/swift/Struct/PassthroughStreamSerializer" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire27PassthroughStreamSerializerV">PassthroughStreamSerializer</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> which performs no serialization on incoming <code>Data</code>.</p>
- <a href="Structs/PassthroughStreamSerializer.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">PassthroughStreamSerializer</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire22StringStreamSerializerV"></a>
- <a name="//apple_ref/swift/Struct/StringStreamSerializer" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire22StringStreamSerializerV">StringStreamSerializer</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a></code> which serializes incoming stream <code>Data</code> into <code>UTF8</code>-decoded <code>String</code> values.</p>
- <a href="Structs/StringStreamSerializer.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">StringStreamSerializer</span> <span class="p">:</span> <span class="kt"><a href="Protocols/DataStreamSerializer.html">DataStreamSerializer</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </div>
- </section>
- </article>
- </div>
- <section class="footer">
- <p>© 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-05-10)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
- </section>
- </body>
- </html>
|