Storage Documentation

Classes

Codable​HTTPCookie

A subclass of HTTPCookie conforming to Codable.

Structures

Keychain​Storage

A struct defining a Storage caching Items safely inside the user's Keychain.

Keychain​Storage.​Iterator

A struct defining a KeychainStorage iterator.

Endpoint​Builder

A struct defining a result builder capable of generating a single endpoint from a collection of components.

Path

A struct defining the path component for a given endpoint.

Response

A struct defining the response transformation.

Tuple3Item

A struct used to hold together partial blocks inside the endpoint builder.

Tuple​Item

A struct used to hold together partial blocks inside the endpoint builder.

Any​Encodable

A struct defining an instance capable of being parsed into some generic JSON file.

Any​Decodable

A struct defining an instance capable of parsing some generic JSON file.

Cellular

A struct defining whether the request for a given endpoint can run on cellular or not. Defaults to true.

Constrained

A struct defining whether the request for a given endpoint should run on a constrained network. Defaults to true.

Expensive

A struct defining whether the request for a given endpoint is considered expensive. Defaults to true.

Service

A struct defining the request network service type for a specific endpoint. /// Defaults to .default.

Timeout

A struct defining when the request for a given endpoint can timeout. Defaults to 60.

Body

A struct defining the request body for a given endpoint. Defaults to nil.

Headers

A struct defining the request headers for a given endpoint. Defaults to empty.

Method

A struct defining the request HTTP method for a given endpoint.

Query

A struct defining the query items for a given endpoint. Defaults to empty.

Catch

A struct defining a custom endpoint implementation handling a request generated by an error in the previous one.

Collect

A struct defining a custom endpoint implementation returning a wrapper for the reduced output of a loop endpoint.

First

A struct defining a custom endpoint implementation returning a wrapper for the first output of a loop endpoint.

Flat​Map

A struct defining a custom endpoint implementation handling a request generated by the response of a previous one.

For​Each

A struct defining a custom endpoint implementation handling a sequence of requests.

Handle​Events

A struct defining a custom endpoint implementation handling success and failures of an existing one, without modifying them.

Last

A struct defining a custom endpoint implementation returning a wrapper for the last output of a loop endpoint.

Loop

A struct defining a custom endpoint implementation handling a paginated request.

Map

A struct defining a custom endpoint implementation handling an output generated from an existing one.

Prefix

A struct defining a custom endpoint implementation returning a wrapper for the first count output of a loop endpoint.

Static

A struct defining some external value to appear inside an endpoint chain (e.g. returning a single value, returning an error, etc).

Any​Loop​Endpoint

A struct defining a loop endpoint erasing all its transformations and mapping, similar to AnyPublisher.

Default​Response

The default URL response.

Providers.​Lock

A struct defining an instance abstracting a lock, a padlock, requiring some key to be opened.

Providers.​Offset

A struct defining an instance abstracting a page reference, identified by some bookmark.

Any​Storage

A struct defining a type-erased instance of Storage.

Transient​Storage

A struct defining a Storage avoiding caching all together.

User​Defaults​Storage

A struct defining a Storage caching Items in UserDefaults.

User​Defaults​Storage.​Iterator

A struct defining a UserDefaultsStorage iterator.

Enumerations

HTTPMethod

An enum listing all URLRequest allowed httpMethods. Defaults to .default.

Endpoints

A module-like enum encapsulating all concrete Endpoint implementations.

Endpoint​Error

An enum listing all available Endpoint-related erros.

Next​Action

An enum listing all possible Loop actions.

Providers

A module-like enum listing all providers.

Protocols

Component

A protocol defining a unique identifier for a specific request component.

Storable

A protocol defining an instance capable of being turned into some Data, while being identified by some Label.

Typealiases

Keychain

A typealias for KeychainAccess.Keychain.

Accessibility

A typealias for KeychainAccess.Accessibility.

Authentication​Policy

A typealias for KeychainAccess.AuthenticationPolicy.

Tuple​Endpoint

The default Tuple3Item.

Functions

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Resolve the current endpoint.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Resolve the current endpoint.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Resolve the current endpoint.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(_:​)

Compose the DefaultResponse.

resolve(_:​)

Compose the DefaultResponse.

resolve(_:​)

Compose the DefaultResponse.

resolve(_:​)

Compose the DefaultResponse.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

resolve(with:​)

Fetch the response, from a given Input and URLSession.

Extensions

CharacterSet
Data
Endpoint
EndpointResolver
HTTPCookiePropertyKey
LockProvider
LoopEndpoint
OffsetProvider
Provider
SingleEndpoint
Storage
String