ResourceCacher Class Reference

public class ResourceCacher<Resource> where Resource : Decodable, Resource : Encodable

A storage to persist a resource and it’s etag, when available.

Resource is stored in the DataStore at the provided fileName, while the etag will be stored at \(fileName)_etag


                    
                    
                    init(dataStore:fileName:)

Creates a resource cacher with the specified data store and file name.

Declaration

Swift

public init(dataStore: any DataStore, fileName: String)

Parameter	Description
`dataStore`	The data store to use for persistence.
`fileName`	The file name for storing the resource.

readResource()
Returns the stored resource, if present and successfully decodable.
Declaration
Swift

public func readResource() -> Resource?
readEtag()
Returns the stored etag, if present.
Declaration
Swift

public func readEtag() -> String?


                    
                    
                    saveResource(_:etag:)

Saves the provided resource with the etag, if provided, in a transaction.

Both the resource and the etag will override previous resources stored at the same location. In case of a nil etag any previous etag present will be deleted.

Declaration

Swift

public func saveResource(_ resource: Resource, etag: String?) throws

Parameter	Description
`resource`	the resource to be stored.
`etag`	the etag to save along with this resource.