diff --git a/docs/data/documentation/bodega.json b/docs/data/documentation/bodega.json index d44ff68..997b197 100644 --- a/docs/data/documentation/bodega.json +++ b/docs/data/documentation/bodega.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega is an actor-based library that started as a simple cache based on reading and writing files to\/from disk with an incredibly simple API. The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" still provides that functionality, but Bodega has also blossomed into much more, offering a form of infrastructure that any app’s data can use."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega’s "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what’s possible. Conforming any database, persistence layer, or even an API server, to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol automatically provides an incredibly simple data layer for your app thanks to Bodega’s "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":". Rather than thinking about "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and databases developers interact with their app’s Swift types no matter what those may be, have a unified API, and concurrency handled out of the box."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega provides two kinds of storage primitives for you, "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":". The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" lets you write "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to your data storage, whether it’s files on disk, SQLite, or your own database. An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" offers a unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"s, providing a single API for saving "},{"type":"codeVoice","code":"Codable"},{"type":"text","text":" objects to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" of your choice. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega"},{"type":"text","text":" has a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" built in, or you can even build a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on your app’s persistencey layer, database, or API server if you want a simple way to interface with your API. Composing storage engines allows you to create complex data pipelines, for example imagine querying the keychain for an API token, hitting your API, and saving the resulting items into a database, all with one API call. The possibilities are endless."}]},{"anchor":"Getting-Started","level":2,"type":"heading","text":"Getting Started"},{"type":"paragraph","inlineContent":[{"type":"text","text":"There are numerous ways to get started with Bodega depending on how you prefer to learn."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can explore using the built-in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" to see how to build an image cache in only a few lines of code."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache"}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The built-in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" should be more than enough to handle most of the tasks iOS and macOS developers perform. It’s still good to know the tradeoffs, or even when you should consider building your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If you want to build a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" for Core Data, the keychain, or your own custom API server, it’ll be wortwhile to explore how the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" works."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Most of the time though you’ll find yourself working with Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" directly, a task "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is perfect for. Learn how to setup "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":", and you’ll be storing Swift types in no time."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega is fully usable and useful on its own, but it’s also the foundation of "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/mergesort\/Boutique"},{"type":"text","text":". If you’re looking to build a complete SwiftUI, UIKit, or AppKit app around these concepts then Boutique is a perfect fit for that problem. The library allows you to build an offline-ready realtime updating app in only a few lines of code."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/build.ms\/boutique\/docs"}]}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"Bodega","title":"Bodega","symbolKind":"module","role":"collection","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[[]]},"topicSections":[{"title":"Fundamentals","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"]},{"title":"Walkthroughs","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache"]},{"title":"Classes","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]},{"title":"Protocols","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]},{"title":"Structures","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]}],"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"https://github.com/mergesort/Boutique":{"title":"Boutique","titleInlineContent":[{"type":"text","text":"Boutique"}],"type":"link","identifier":"https:\/\/github.com\/mergesort\/Boutique","url":"https:\/\/github.com\/mergesort\/Boutique"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/Building-An-Image-Cache":{"role":"article","title":"Building An Image Cache","abstract":[{"type":"text","text":"Bodega takes data management off your plate, making once complex problems like building an image cache much simpler."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache","kind":"article","type":"topic","url":"\/documentation\/bodega\/building-an-image-cache"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/Using-StorageEngines":{"role":"article","title":"Using StorageEngines","abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-storageengines"},"https://build.ms/boutique/docs":{"title":"Boutique Documentation","titleInlineContent":[{"type":"text","text":"Boutique Documentation"}],"type":"link","identifier":"https:\/\/build.ms\/boutique\/docs","url":"https:\/\/build.ms\/boutique\/docs"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/Using-ObjectStorage":{"role":"article","title":"Using ObjectStorage","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-objectstorage"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega is an actor-based library that started as a simple cache based on reading and writing files to\/from disk with an incredibly simple API. The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" still provides that functionality, but Bodega has also blossomed into much more, offering a form of infrastructure that any app’s data can use."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega’s "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what’s possible. Conforming any database, persistence layer, or even an API server, to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol automatically provides an incredibly simple data layer for your app thanks to Bodega’s "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":". Rather than thinking about "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and databases developers interact with their app’s Swift types no matter what those may be, have a unified API, and concurrency handled out of the box."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega provides two kinds of storage primitives for you, "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":". The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" lets you write "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to your data storage, whether it’s files on disk, SQLite, or your own database. An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" offers a unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"s, providing a single API for saving "},{"type":"codeVoice","code":"Codable"},{"type":"text","text":" objects to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" of your choice. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega"},{"type":"text","text":" has a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" built in, or you can even build a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on your app’s persistencey layer, database, or API server if you want a simple way to interface with your API. Composing storage engines allows you to create complex data pipelines, for example imagine querying the keychain for an API token, hitting your API, and saving the resulting items into a database, all with one API call. The possibilities are endless."}]},{"anchor":"Getting-Started","level":2,"type":"heading","text":"Getting Started"},{"type":"paragraph","inlineContent":[{"type":"text","text":"There are numerous ways to get started with Bodega depending on how you prefer to learn."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can explore using the built-in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" to see how to build an image cache in only a few lines of code."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache"}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The built-in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" should be more than enough to handle most of the tasks iOS and macOS developers perform. It’s still good to know the tradeoffs, or even when you should consider building your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If you want to build a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" for Core Data, the keychain, or your own custom API server, it’ll be wortwhile to explore how the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" works."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Most of the time though you’ll find yourself working with Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" directly, a task "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is perfect for. Learn how to setup "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":", and you’ll be storing Swift types in no time."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Bodega is fully usable and useful on its own, but it’s also the foundation of "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/mergesort\/Boutique"},{"type":"text","text":". If you’re looking to build a complete SwiftUI, UIKit, or AppKit app around these concepts then Boutique is a perfect fit for that problem. The library allows you to build an offline-ready realtime updating app in only a few lines of code."}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/build.ms\/boutique\/docs"}]}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"Bodega","title":"Bodega","symbolKind":"module","role":"collection","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[[]]},"topicSections":[{"title":"Fundamentals","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"]},{"title":"Walkthroughs","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache"]},{"title":"Classes","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]},{"title":"Protocols","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]},{"title":"Structures","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]}],"references":{"https://build.ms/boutique/docs":{"title":"Boutique Documentation","titleInlineContent":[{"type":"text","text":"Boutique Documentation"}],"type":"link","identifier":"https:\/\/build.ms\/boutique\/docs","url":"https:\/\/build.ms\/boutique\/docs"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"https://github.com/mergesort/Boutique":{"title":"Boutique","titleInlineContent":[{"type":"text","text":"Boutique"}],"type":"link","identifier":"https:\/\/github.com\/mergesort\/Boutique","url":"https:\/\/github.com\/mergesort\/Boutique"},"doc://Bodega/documentation/Bodega/Building-An-Image-Cache":{"role":"article","title":"Building An Image Cache","abstract":[{"type":"text","text":"Bodega takes data management off your plate, making once complex problems like building an image cache much simpler."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache","kind":"article","type":"topic","url":"\/documentation\/bodega\/building-an-image-cache"},"doc://Bodega/documentation/Bodega/Using-StorageEngines":{"role":"article","title":"Using StorageEngines","abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-storageengines"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/Using-ObjectStorage":{"role":"article","title":"Using ObjectStorage","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-objectstorage"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/building-an-image-cache.json b/docs/data/documentation/bodega/building-an-image-cache.json index 386dddd..a838d47 100644 --- a/docs/data/documentation/bodega/building-an-image-cache.json +++ b/docs/data/documentation/bodega/building-an-image-cache.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"When you’re building an app that displays images the first thing you need to do is build an image cache. An image cache provides numerous benefits. It lets your app work offline, makes sure you never have to redownload images you’ve already saved, and it makes your app faster by skipping unnecessary network requests."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"In this tutorial we’ll build an image cache, connect it to a SwiftUI View, and demonstrate a good pattern for querying cached data. While the cache we’ll build is for images, the same approach works for any data, whether you want to save videos, HTML, or even custom files. You can even use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to cache your app’s models, as discussed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"},{"type":"text","text":"."}]},{"anchor":"ImageCache","level":2,"type":"heading","text":"ImageCache"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Below is the "},{"type":"codeVoice","code":"ImageCache"},{"type":"text","text":", and like any cache it has an operation to save data and an operation to retrieve data."}]},{"type":"codeListing","syntax":"swift","code":["import Bodega","","final class ImageCache: ObservableObject {",""," \/\/ 1"," private let imageStore = SQLiteStorageEngine.default(appendingPath: \"Images\")",""," init() { }",""," \/\/ 2"," func cache(image: UIImage, forKey key: CacheKey) async throws {"," guard let data = image.pngData() else { return }"," try await self.imageStore.write(data, key: key)"," }",""," \/\/ 3"," func image(forKey key: CacheKey) async -> UIImage? {"," guard let imageData = await self.imageStore.read(key: key) else { return nil }"," return UIImage(data: imageData)"," }","","}"]},{"type":"orderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"We create an instance of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" ("},{"type":"codeVoice","code":"imagesStore"},{"type":"text","text":") to hold the images we will be caching. The document "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"},{"type":"text","text":" discusses the differences between "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" in depth, you can use either for this task but we’ll choose to use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Our "},{"type":"codeVoice","code":"cache(image: UIImage, forKey: CacheKey)"},{"type":"text","text":" function does one thing and does it well. If the image passed into the function can be converted to "},{"type":"codeVoice","code":"Data"},{"type":"text","text":", we will write that "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" into the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If it can’t write the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" we’ll return early instead. If there are any errors thrown when writing the data they will be provided to the caller of the "},{"type":"codeVoice","code":"cache"},{"type":"text","text":" function."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Our "},{"type":"codeVoice","code":"image(forKey: CacheKey)"},{"type":"text","text":" function is similarly focused, tasked with retrieving an image from the cache if that image exists in our cache. If you haven’t yet retrieved an image from the server then it won’t be in the cache. This case is very common so it doesn’t make sense to throw errors, instead a "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" value signals to us that we have a reason to attempt retrieving an image from our API."}]}]}]},{"anchor":"ImageFetchingAPI","level":2,"type":"heading","text":"ImageFetchingAPI"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Now that we have a cache for storing images, we’ll need to fetch images to store. We won’t build a real API for the purposes of this tutorial, but this approach should work for fetching any image from the internet."}]},{"type":"codeListing","syntax":"swift","code":["struct ImageFetchingAPI {",""," func download(url: URL) async -> UIImage {"," \/\/ Make a network call download an image"," return UIImage()"," }","","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"For our "},{"type":"codeVoice","code":"ImageFetchingAPI"},{"type":"text","text":" our "},{"type":"codeVoice","code":"download(url: URL)"},{"type":"text","text":" function will use the "},{"type":"codeVoice","code":"url"},{"type":"text","text":" parameter provided to download an image."}]},{"anchor":"ProfileHeaderView","level":2,"type":"heading","text":"ProfileHeaderView"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Having the ability to save, load, and download images is great, but for the user to enjoy the image we’ll need to put the image into a "},{"type":"codeVoice","code":"View"},{"type":"text","text":". Let’s imagine we’re a navigation bar that shows a user of our Jolene app their avatar if an avatar exists."}]},{"type":"paragraph","inlineContent":[{"type":"image","identifier":"ProfileHeaderview.png"}]},{"type":"codeListing","syntax":"swift","code":["import SwiftUI","","struct ProfileHeaderView: View {",""," \/\/ 1 "," @StateObject private var imageCache = ImageCache()",""," \/\/ 2"," @State private var avatarImage: UIImage?",""," private static let avatarCacheKey = CacheKey(\"username-avatar\")",""," var body: some View {"," HStack {"," \/\/ 3"," if let headerImage = self.avatarImage {"," Image(uiImage: headerImage)"," .frame(width: 32.0, height: 32.0)"," } else {"," Rectangle()"," .background(Color.blue)"," .cornerRadius(8.0)"," .frame(width: 32.0, height: 32.0)"," }",""," Spacer()",""," Text(\"Jolene 🌻\")",""," Spacer()"," }"," .frame(alignment: .center)"," }.task({"," \/\/ 4"," if let cachedImage = await self.imageCache.image(forKey: Self.avatarCacheKey) {"," self.avatarImage = cachedImage"," } else { "," let imageAPI = ImageFetchingAPI()"," let avatarImage = await imageAPI.fetchAvatar()"," self.avatarImage = avatarImage"," try? await self.imageCache.cache(image: avatarImage, forKey: Self.avatarCacheKey)"," }"," })"," }","}"]},{"type":"orderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Our "},{"type":"codeVoice","code":"ProfileHeaderview"},{"type":"text","text":" needs to have an instance of "},{"type":"codeVoice","code":"ImageCache"},{"type":"text","text":", that way we can retrieve the image we want to display from our cache. Some developers may prefer to put this property into a "},{"type":"codeVoice","code":"ViewModel"},{"type":"text","text":", and that’s a configuration Bodega supports. Bodega isn’t prescriptive, it only focuses on storing and loading data, you can choose the rest and figure out what approach is best for you."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"We’ll create an "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" property to store the avatar image we will retrieve. It will be "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" by default, but will be updated when we fetch an image from either our cache or from the API. Marking the property with "},{"type":"codeVoice","code":"@State"},{"type":"text","text":" signals to our "},{"type":"codeVoice","code":"ProfileHeaderView"},{"type":"text","text":" to automatically refresh when an image is retrieved, no matter the source of the image."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Here we have an if condition depending on whether "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" exists or not. If "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" is "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" we will render a lovely blue rectangle that serves as a placeholder for when we retrieve an image. If "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" is not "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", we will display the user’s avatar as expected. The beauty of the cache is that if we’ve already downloaded the image before we won’t have to wait for a network request to our API, instead the user will immediately see the avatar image as expected."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"There are two distinct pathways in our "},{"type":"codeVoice","code":".task"},{"type":"text","text":", so let’s go over the "},{"type":"codeVoice","code":"if"},{"type":"text","text":" and the "},{"type":"codeVoice","code":"else"},{"type":"text","text":" blocks separately."}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":".task"},{"type":"text","text":" will run when the view appears, immediately checking to see if the image already exists in the cache. If it does we will set "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" to the image we find in the cache so the user immediately sees their avatar in the header."}]},{"type":"codeListing","syntax":"swift","code":["if let cachedImage = await self.imageCache.image(forKey: Self.avatarCacheKey) {"," self.avatarImage = cachedImage","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the image isn’t yet cached we will end up in the "},{"type":"codeVoice","code":"else"},{"type":"text","text":" block. In that case we will"}]},{"type":"orderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Download the user’s avatar from our API,"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Set the result to "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":","}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Finish up the process by calling "},{"type":"codeVoice","code":"imageCache.cache(image: avatarImage, forKey: Self.avatarCacheKey)"},{"type":"text","text":" to ensure that the next time we need this avatar we have it cached."}]}]}]},{"type":"codeListing","syntax":"swift","code":["let imageAPI = ImageFetchingAPI()","let avatarImage = await imageAPI.download(url: URL(string: \"https:\/\/image.redpanda.club\/random\")!)","self.avatarImage = avatarImage","try? await self.imageCache.cache(image: avatarImage, forKey: Self.avatarCacheKey)"]},{"anchor":"Further-Exploration","level":2,"type":"heading","text":"Further Exploration"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Building a performant and reliable cache can be a difficult task, but with Bodega’s help we were able to build one in only a few lines of code. There are many complex abstractions you can build much more simply using Bodega."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"As we saw above Bodega is fully usable and useful on its own, but it’s also the foundation of "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/mergesort\/Boutique"},{"type":"text","text":". Boutique helps you build a complete SwiftUI, UIKit, or AppKit app that works fully offline with the help of a similar caching approach as built for our image cache. But Boutique goes above and beyond that, providing realtime updates to your views so they’re always showing the most up to date data based on your cached data. If you’d like to build an app with all of these capabilities in only a few lines of code, it’s easy to get started with "},{"type":"reference","isActive":true,"identifier":"https:\/\/build.ms\/boutique\/docs"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/building-an-image-cache"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Bodega takes data management off your plate, making once complex problems like building an image cache much simpler."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Building An Image Cache","role":"article","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"references":{"ProfileHeaderview.png":{"alt":"Profile Header View","type":"image","identifier":"ProfileHeaderview.png","variants":[{"url":"\/images\/ProfileHeaderview.png","traits":["1x","light"]}]},"https://build.ms/boutique/docs":{"title":"Boutique’s documentation","titleInlineContent":[{"type":"text","text":"Boutique’s documentation"}],"type":"link","identifier":"https:\/\/build.ms\/boutique\/docs","url":"https:\/\/build.ms\/boutique\/docs"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/Using-ObjectStorage":{"role":"article","title":"Using ObjectStorage","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"https://github.com/mergesort/Boutique":{"title":"Boutique","titleInlineContent":[{"type":"text","text":"Boutique"}],"type":"link","identifier":"https:\/\/github.com\/mergesort\/Boutique","url":"https:\/\/github.com\/mergesort\/Boutique"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/Using-StorageEngines":{"role":"article","title":"Using StorageEngines","abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-storageengines"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"When you’re building an app that displays images the first thing you need to do is build an image cache. An image cache provides numerous benefits. It lets your app work offline, makes sure you never have to redownload images you’ve already saved, and it makes your app faster by skipping unnecessary network requests."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"In this tutorial we’ll build an image cache, connect it to a SwiftUI View, and demonstrate a good pattern for querying cached data. While the cache we’ll build is for images, the same approach works for any data, whether you want to save videos, HTML, or even custom files. You can even use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to cache your app’s models, as discussed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"},{"type":"text","text":"."}]},{"anchor":"ImageCache","level":2,"type":"heading","text":"ImageCache"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Below is the "},{"type":"codeVoice","code":"ImageCache"},{"type":"text","text":", and like any cache it has an operation to save data and an operation to retrieve data."}]},{"type":"codeListing","syntax":"swift","code":["import Bodega","","final class ImageCache: ObservableObject {",""," \/\/ 1"," private let imageStore = SQLiteStorageEngine.default(appendingPath: \"Images\")",""," init() { }",""," \/\/ 2"," func cache(image: UIImage, forKey key: CacheKey) async throws {"," guard let data = image.pngData() else { return }"," try await self.imageStore.write(data, key: key)"," }",""," \/\/ 3"," func image(forKey key: CacheKey) async -> UIImage? {"," guard let imageData = await self.imageStore.read(key: key) else { return nil }"," return UIImage(data: imageData)"," }","","}"]},{"type":"orderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"We create an instance of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" ("},{"type":"codeVoice","code":"imagesStore"},{"type":"text","text":") to hold the images we will be caching. The document "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"},{"type":"text","text":" discusses the differences between "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" in depth, you can use either for this task but we’ll choose to use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Our "},{"type":"codeVoice","code":"cache(image: UIImage, forKey: CacheKey)"},{"type":"text","text":" function does one thing and does it well. If the image passed into the function can be converted to "},{"type":"codeVoice","code":"Data"},{"type":"text","text":", we will write that "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" into the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If it can’t write the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" we’ll return early instead. If there are any errors thrown when writing the data they will be provided to the caller of the "},{"type":"codeVoice","code":"cache"},{"type":"text","text":" function."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Our "},{"type":"codeVoice","code":"image(forKey: CacheKey)"},{"type":"text","text":" function is similarly focused, tasked with retrieving an image from the cache if that image exists in our cache. If you haven’t yet retrieved an image from the server then it won’t be in the cache. This case is very common so it doesn’t make sense to throw errors, instead a "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" value signals to us that we have a reason to attempt retrieving an image from our API."}]}]}]},{"anchor":"ImageFetchingAPI","level":2,"type":"heading","text":"ImageFetchingAPI"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Now that we have a cache for storing images, we’ll need to fetch images to store. We won’t build a real API for the purposes of this tutorial, but this approach should work for fetching any image from the internet."}]},{"type":"codeListing","syntax":"swift","code":["struct ImageFetchingAPI {",""," func download(url: URL) async -> UIImage {"," \/\/ Make a network call download an image"," return UIImage()"," }","","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"For our "},{"type":"codeVoice","code":"ImageFetchingAPI"},{"type":"text","text":" our "},{"type":"codeVoice","code":"download(url: URL)"},{"type":"text","text":" function will use the "},{"type":"codeVoice","code":"url"},{"type":"text","text":" parameter provided to download an image."}]},{"anchor":"ProfileHeaderView","level":2,"type":"heading","text":"ProfileHeaderView"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Having the ability to save, load, and download images is great, but for the user to enjoy the image we’ll need to put the image into a "},{"type":"codeVoice","code":"View"},{"type":"text","text":". Let’s imagine we’re a navigation bar that shows a user of our Jolene app their avatar if an avatar exists."}]},{"type":"paragraph","inlineContent":[{"type":"image","identifier":"ProfileHeaderview.png"}]},{"type":"codeListing","syntax":"swift","code":["import SwiftUI","","struct ProfileHeaderView: View {",""," \/\/ 1 "," @StateObject private var imageCache = ImageCache()",""," \/\/ 2"," @State private var avatarImage: UIImage?",""," private static let avatarCacheKey = CacheKey(\"username-avatar\")",""," var body: some View {"," HStack {"," \/\/ 3"," if let headerImage = self.avatarImage {"," Image(uiImage: headerImage)"," .frame(width: 32.0, height: 32.0)"," } else {"," Rectangle()"," .background(Color.blue)"," .cornerRadius(8.0)"," .frame(width: 32.0, height: 32.0)"," }",""," Spacer()",""," Text(\"Jolene 🌻\")",""," Spacer()"," }"," .frame(alignment: .center)"," }.task({"," \/\/ 4"," if let cachedImage = await self.imageCache.image(forKey: Self.avatarCacheKey) {"," self.avatarImage = cachedImage"," } else { "," let imageAPI = ImageFetchingAPI()"," let avatarImage = await imageAPI.fetchAvatar()"," self.avatarImage = avatarImage"," try? await self.imageCache.cache(image: avatarImage, forKey: Self.avatarCacheKey)"," }"," })"," }","}"]},{"type":"orderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Our "},{"type":"codeVoice","code":"ProfileHeaderview"},{"type":"text","text":" needs to have an instance of "},{"type":"codeVoice","code":"ImageCache"},{"type":"text","text":", that way we can retrieve the image we want to display from our cache. Some developers may prefer to put this property into a "},{"type":"codeVoice","code":"ViewModel"},{"type":"text","text":", and that’s a configuration Bodega supports. Bodega isn’t prescriptive, it only focuses on storing and loading data, you can choose the rest and figure out what approach is best for you."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"We’ll create an "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" property to store the avatar image we will retrieve. It will be "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" by default, but will be updated when we fetch an image from either our cache or from the API. Marking the property with "},{"type":"codeVoice","code":"@State"},{"type":"text","text":" signals to our "},{"type":"codeVoice","code":"ProfileHeaderView"},{"type":"text","text":" to automatically refresh when an image is retrieved, no matter the source of the image."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Here we have an if condition depending on whether "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" exists or not. If "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" is "},{"type":"codeVoice","code":"nil"},{"type":"text","text":" we will render a lovely blue rectangle that serves as a placeholder for when we retrieve an image. If "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" is not "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", we will display the user’s avatar as expected. The beauty of the cache is that if we’ve already downloaded the image before we won’t have to wait for a network request to our API, instead the user will immediately see the avatar image as expected."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"There are two distinct pathways in our "},{"type":"codeVoice","code":".task"},{"type":"text","text":", so let’s go over the "},{"type":"codeVoice","code":"if"},{"type":"text","text":" and the "},{"type":"codeVoice","code":"else"},{"type":"text","text":" blocks separately."}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":".task"},{"type":"text","text":" will run when the view appears, immediately checking to see if the image already exists in the cache. If it does we will set "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":" to the image we find in the cache so the user immediately sees their avatar in the header."}]},{"type":"codeListing","syntax":"swift","code":["if let cachedImage = await self.imageCache.image(forKey: Self.avatarCacheKey) {"," self.avatarImage = cachedImage","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the image isn’t yet cached we will end up in the "},{"type":"codeVoice","code":"else"},{"type":"text","text":" block. In that case we will"}]},{"type":"orderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Download the user’s avatar from our API,"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Set the result to "},{"type":"codeVoice","code":"avatarImage"},{"type":"text","text":","}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Finish up the process by calling "},{"type":"codeVoice","code":"imageCache.cache(image: avatarImage, forKey: Self.avatarCacheKey)"},{"type":"text","text":" to ensure that the next time we need this avatar we have it cached."}]}]}]},{"type":"codeListing","syntax":"swift","code":["let imageAPI = ImageFetchingAPI()","let avatarImage = await imageAPI.download(url: URL(string: \"https:\/\/image.redpanda.club\/random\")!)","self.avatarImage = avatarImage","try? await self.imageCache.cache(image: avatarImage, forKey: Self.avatarCacheKey)"]},{"anchor":"Further-Exploration","level":2,"type":"heading","text":"Further Exploration"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Building a performant and reliable cache can be a difficult task, but with Bodega’s help we were able to build one in only a few lines of code. There are many complex abstractions you can build much more simply using Bodega."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"As we saw above Bodega is fully usable and useful on its own, but it’s also the foundation of "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/mergesort\/Boutique"},{"type":"text","text":". Boutique helps you build a complete SwiftUI, UIKit, or AppKit app that works fully offline with the help of a similar caching approach as built for our image cache. But Boutique goes above and beyond that, providing realtime updates to your views so they’re always showing the most up to date data based on your cached data. If you’d like to build an app with all of these capabilities in only a few lines of code, it’s easy to get started with "},{"type":"reference","isActive":true,"identifier":"https:\/\/build.ms\/boutique\/docs"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/building-an-image-cache"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/Building-An-Image-Cache","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Bodega takes data management off your plate, making once complex problems like building an image cache much simpler."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Building An Image Cache","role":"article","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"ProfileHeaderview.png":{"alt":"Profile Header View","type":"image","identifier":"ProfileHeaderview.png","variants":[{"url":"\/images\/ProfileHeaderview.png","traits":["1x","light"]}]},"https://github.com/mergesort/Boutique":{"title":"Boutique","titleInlineContent":[{"type":"text","text":"Boutique"}],"type":"link","identifier":"https:\/\/github.com\/mergesort\/Boutique","url":"https:\/\/github.com\/mergesort\/Boutique"},"https://build.ms/boutique/docs":{"title":"Boutique’s documentation","titleInlineContent":[{"type":"text","text":"Boutique’s documentation"}],"type":"link","identifier":"https:\/\/build.ms\/boutique\/docs","url":"https:\/\/build.ms\/boutique\/docs"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/Using-ObjectStorage":{"role":"article","title":"Using ObjectStorage","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-objectstorage"},"doc://Bodega/documentation/Bodega/Using-StorageEngines":{"role":"article","title":"Using StorageEngines","abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-storageengines"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/cachekey.json b/docs/data/documentation/bodega/cachekey.json index 40c93b2..cfed1ae 100644 --- a/docs/data/documentation/bodega/cachekey.json +++ b/docs/data/documentation/bodega/cachekey.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/Se","doc:\/\/Bodega\/SE","doc:\/\/Bodega\/SQ","doc:\/\/Bodega\/SH"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","interfaceLanguage":"swift"},"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"title":"CacheKey","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:6Bodega8CacheKeyV","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"CacheKey"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/value"]},{"title":"Default Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations"],"generated":true}],"references":{"doc://Bodega/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/Bodega\/SQ"},"doc://Bodega/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/Bodega\/SH"},"doc://Bodega/documentation/Bodega/CacheKey/init(url:)":{"role":"symbol","title":"init(url:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"URL"},{"type":"text","text":". This initializer is useful if you plan on using"},{"type":"text","text":" "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s for storing files on disk because file have many limitations about"},{"type":"text","text":" "},{"type":"text","text":"which characters that are allowed in file names, and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(url:)"},"doc://Bodega/documentation/Bodega/CacheKey/value":{"role":"symbol","title":"value","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"String"},{"type":"text","text":" representation of your "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/value","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/value"},"doc://Bodega/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/Bodega\/SE"},"doc://Bodega/documentation/Bodega/CacheKey/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(from:)"},"doc://Bodega/documentation/Bodega/CacheKey/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/cachekey\/equatable-implementations"},"doc://Bodega/documentation/Bodega/CacheKey/init(_:)":{"role":"symbol","title":"init(_:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", creating a hashed version of the input "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"This initializer is useful if you plan on using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s for storing files on disk"},{"type":"text","text":" "},{"type":"text","text":"because file have many limitations about characters that are allowed in file names,"},{"type":"text","text":" "},{"type":"text","text":"and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(_:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/Bodega\/Se"},"doc://Bodega/documentation/Bodega/CacheKey/init(verbatim:)":{"role":"symbol","title":"init(verbatim:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", using the exact "},{"type":"codeVoice","code":"String"},{"type":"text","text":" as the value of the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(verbatim:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/Se","doc:\/\/Bodega\/SE","doc:\/\/Bodega\/SQ","doc:\/\/Bodega\/SH"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","interfaceLanguage":"swift"},"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"title":"CacheKey","roleHeading":"Structure","role":"symbol","symbolKind":"struct","externalID":"s:6Bodega8CacheKeyV","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"CacheKey"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/value"]},{"title":"Default Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations"],"generated":true}],"references":{"doc://Bodega/documentation/Bodega/CacheKey/init(verbatim:)":{"role":"symbol","title":"init(verbatim:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", using the exact "},{"type":"codeVoice","code":"String"},{"type":"text","text":" as the value of the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(verbatim:)"},"doc://Bodega/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/Bodega\/SH"},"doc://Bodega/documentation/Bodega/CacheKey/init(url:)":{"role":"symbol","title":"init(url:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"URL"},{"type":"text","text":". This initializer is useful if you plan on using"},{"type":"text","text":" "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s for storing files on disk because file have many limitations about"},{"type":"text","text":" "},{"type":"text","text":"which characters that are allowed in file names, and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(url:)"},"doc://Bodega/documentation/Bodega/CacheKey/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/cachekey\/equatable-implementations"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/CacheKey/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(from:)"},"doc://Bodega/documentation/Bodega/CacheKey/init(_:)":{"role":"symbol","title":"init(_:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", creating a hashed version of the input "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"This initializer is useful if you plan on using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s for storing files on disk"},{"type":"text","text":" "},{"type":"text","text":"because file have many limitations about characters that are allowed in file names,"},{"type":"text","text":" "},{"type":"text","text":"and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(_:)"},"doc://Bodega/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/Bodega\/SQ"},"doc://Bodega/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/Bodega\/Se"},"doc://Bodega/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/Bodega\/SE"},"doc://Bodega/documentation/Bodega/CacheKey/value":{"role":"symbol","title":"value","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"String"},{"type":"text","text":" representation of your "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/value","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/value"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/cachekey/!=(_:_:).json b/docs/data/documentation/bodega/cachekey/!=(_:_:).json index f87838a..d2312b2 100644 --- a/docs/data/documentation/bodega/cachekey/!=(_:_:).json +++ b/docs/data/documentation/bodega/cachekey/!=(_:_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/!=(_:_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"!=(_:_:)","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"symbolKind":"op","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:6Bodega8CacheKeyV","extendedModule":"Swift","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/cachekey\/equatable-implementations"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/CacheKey/!=(_:_:)":{"role":"symbol","title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/!=(_:_:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/!=(_:_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"!=(_:_:)","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"symbolKind":"op","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:6Bodega8CacheKeyV","extendedModule":"Swift","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey/!=(_:_:)":{"role":"symbol","title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/!=(_:_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/!=(_:_:)"},"doc://Bodega/documentation/Bodega/CacheKey/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/cachekey\/equatable-implementations"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/cachekey/init(_:).json b/docs/data/documentation/bodega/cachekey/init(_:).json index fb6cd38..81cb87c 100644 --- a/docs/data/documentation/bodega/cachekey/init(_:).json +++ b/docs/data/documentation/bodega/cachekey/init(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"value","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"String"},{"type":"text","text":" which will serve as the underlying value for this "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", creating a hashed version of the input "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"This initializer is useful if you plan on using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s for storing files on disk"},{"type":"text","text":" "},{"type":"text","text":"because file have many limitations about characters that are allowed in file names,"},{"type":"text","text":" "},{"type":"text","text":"and the maximum length of a file name."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"title":"init(_:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyVyACSScfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/CacheKey/init(_:)":{"role":"symbol","title":"init(_:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", creating a hashed version of the input "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"This initializer is useful if you plan on using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s for storing files on disk"},{"type":"text","text":" "},{"type":"text","text":"because file have many limitations about characters that are allowed in file names,"},{"type":"text","text":" "},{"type":"text","text":"and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(_:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"value","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"String"},{"type":"text","text":" which will serve as the underlying value for this "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", creating a hashed version of the input "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"This initializer is useful if you plan on using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s for storing files on disk"},{"type":"text","text":" "},{"type":"text","text":"because file have many limitations about characters that are allowed in file names,"},{"type":"text","text":" "},{"type":"text","text":"and the maximum length of a file name."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"title":"init(_:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyVyACSScfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey/init(_:)":{"role":"symbol","title":"init(_:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", creating a hashed version of the input "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"This initializer is useful if you plan on using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s for storing files on disk"},{"type":"text","text":" "},{"type":"text","text":"because file have many limitations about characters that are allowed in file names,"},{"type":"text","text":" "},{"type":"text","text":"and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(_:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/cachekey/init(from:).json b/docs/data/documentation/bodega/cachekey/init(from:).json index ec01745..1e855e3 100644 --- a/docs/data/documentation/bodega/cachekey/init(from:).json +++ b/docs/data/documentation/bodega/cachekey/init(from:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(from:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(from:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(from:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/cachekey/init(url:).json b/docs/data/documentation/bodega/cachekey/init(url:).json index ab4586b..52e2e2c 100644 --- a/docs/data/documentation/bodega/cachekey/init(url:).json +++ b/docs/data/documentation/bodega/cachekey/init(url:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"url","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The URL to use as the foundation of your cache key."},{"type":"text","text":" "},{"type":"text","text":"The URL will be sanitized to account for common user-generated differences"},{"type":"text","text":" "},{"type":"text","text":"before generating a cache key, so note that https:\/\/redpanda.club and https:\/\/www.redpanda.club"},{"type":"text","text":" "},{"type":"text","text":"will generate a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" with the same underlying value."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(url:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"URL"},{"type":"text","text":". This initializer is useful if you plan on using"},{"type":"text","text":" "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s for storing files on disk because file have many limitations about"},{"type":"text","text":" "},{"type":"text","text":"which characters that are allowed in file names, and the maximum length of a file name."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"title":"init(url:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyV3urlAC10Foundation3URLV_tcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey/init(url:)":{"role":"symbol","title":"init(url:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"URL"},{"type":"text","text":". This initializer is useful if you plan on using"},{"type":"text","text":" "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s for storing files on disk because file have many limitations about"},{"type":"text","text":" "},{"type":"text","text":"which characters that are allowed in file names, and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(url:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"url","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The URL to use as the foundation of your cache key."},{"type":"text","text":" "},{"type":"text","text":"The URL will be sanitized to account for common user-generated differences"},{"type":"text","text":" "},{"type":"text","text":"before generating a cache key, so note that https:\/\/redpanda.club and https:\/\/www.redpanda.club"},{"type":"text","text":" "},{"type":"text","text":"will generate a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" with the same underlying value."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(url:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"URL"},{"type":"text","text":". This initializer is useful if you plan on using"},{"type":"text","text":" "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s for storing files on disk because file have many limitations about"},{"type":"text","text":" "},{"type":"text","text":"which characters that are allowed in file names, and the maximum length of a file name."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"title":"init(url:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyV3urlAC10Foundation3URLV_tcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/CacheKey/init(url:)":{"role":"symbol","title":"init(url:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"URL"},{"type":"text","text":". This initializer is useful if you plan on using"},{"type":"text","text":" "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s for storing files on disk because file have many limitations about"},{"type":"text","text":" "},{"type":"text","text":"which characters that are allowed in file names, and the maximum length of a file name."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(url:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(url:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/cachekey/init(verbatim:).json b/docs/data/documentation/bodega/cachekey/init(verbatim:).json index 15a3e48..cd44181 100644 --- a/docs/data/documentation/bodega/cachekey/init(verbatim:).json +++ b/docs/data/documentation/bodega/cachekey/init(verbatim:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":" "},{"kind":"internalParam","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"value","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"String"},{"type":"text","text":" which will serve as the underlying value for this "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(verbatim:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", using the exact "},{"type":"codeVoice","code":"String"},{"type":"text","text":" as the value of the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"title":"init(verbatim:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyV8verbatimACSS_tcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey/init(verbatim:)":{"role":"symbol","title":"init(verbatim:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", using the exact "},{"type":"codeVoice","code":"String"},{"type":"text","text":" as the value of the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(verbatim:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":" "},{"kind":"internalParam","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"value","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"String"},{"type":"text","text":" which will serve as the underlying value for this "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/cachekey\/init(verbatim:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", using the exact "},{"type":"codeVoice","code":"String"},{"type":"text","text":" as the value of the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"title":"init(verbatim:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega8CacheKeyV8verbatimACSS_tcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/CacheKey/init(verbatim:)":{"role":"symbol","title":"init(verbatim:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"verbatim"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from a "},{"type":"codeVoice","code":"String"},{"type":"text","text":", using the exact "},{"type":"codeVoice","code":"String"},{"type":"text","text":" as the value of the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey\/init(verbatim:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/cachekey\/init(verbatim:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine.json b/docs/data/documentation/bodega/diskstorageengine.json index 7e0b157..50e6fba 100644 --- a/docs/data/documentation/bodega/diskstorageengine.json +++ b/docs/data/documentation/bodega/diskstorageengine.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"actor"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" prioritizes simplicity over speed, it is very easy to use and understand."},{"type":"text","text":" "},{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" will write a one file for every object you save, which makes"},{"type":"text","text":" "},{"type":"text","text":"it easy to inspect and debug any objects you’re saving."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Initialization times vary based on the total number of objects you have saved,"},{"type":"text","text":" "},{"type":"text","text":"but a simple rule of thumb is that loading 1,000 objects from disk takes about 0.25 seconds."},{"type":"text","text":" "},{"type":"text","text":"This can start to feel a bit slow if you are saving more than 2,000-3,000, at which point"},{"type":"text","text":" "},{"type":"text","text":"it may be worth investigating alternative "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"s."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If performance is important "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega"},{"type":"text","text":" ships "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":", and that is the recommended"},{"type":"text","text":" "},{"type":"text","text":"default "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If you have your own persistence layer such as Realm, Core Data, etc,"},{"type":"text","text":" "},{"type":"text","text":"you can easily build your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" to plug into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"title":"DiskStorageEngine","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:6Bodega17DiskStorageEngineC","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/init(directory:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)"]},{"title":"Default Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations"],"generated":true}],"references":{"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keycount()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/lastAccessed(key:)":{"role":"symbol","title":"lastAccessed(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the last access date of the file for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/lastaccessed(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/StorageEngine-Implementations":{"role":"collectionGroup","title":"StorageEngine Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldataandkeys()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/init(directory:)":{"role":"symbol","title":"init(directory:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/init(directory:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/init(directory:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/removealldata()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the updatedAt date for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:key:)"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"actor"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" prioritizes simplicity over speed, it is very easy to use and understand."},{"type":"text","text":" "},{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" will write a one file for every object you save, which makes"},{"type":"text","text":" "},{"type":"text","text":"it easy to inspect and debug any objects you’re saving."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Initialization times vary based on the total number of objects you have saved,"},{"type":"text","text":" "},{"type":"text","text":"but a simple rule of thumb is that loading 1,000 objects from disk takes about 0.25 seconds."},{"type":"text","text":" "},{"type":"text","text":"This can start to feel a bit slow if you are saving more than 2,000-3,000, at which point"},{"type":"text","text":" "},{"type":"text","text":"it may be worth investigating alternative "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"s."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If performance is important "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega"},{"type":"text","text":" ships "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":", and that is the recommended"},{"type":"text","text":" "},{"type":"text","text":"default "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If you have your own persistence layer such as Realm, Core Data, etc,"},{"type":"text","text":" "},{"type":"text","text":"you can easily build your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" to plug into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"title":"DiskStorageEngine","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:6Bodega17DiskStorageEngineC","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/init(directory:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)"]},{"title":"Default Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations"],"generated":true}],"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keycount()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the updatedAt date for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/init(directory:)":{"role":"symbol","title":"init(directory:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/init(directory:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/init(directory:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/lastAccessed(key:)":{"role":"symbol","title":"lastAccessed(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the last access date of the file for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/lastaccessed(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldataandkeys()"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/removealldata()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/StorageEngine-Implementations":{"role":"collectionGroup","title":"StorageEngine Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"},"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/allkeys().json b/docs/data/documentation/bodega/diskstorageengine/allkeys().json index 95f14a9..e97e706 100644 --- a/docs/data/documentation/bodega/diskstorageengine/allkeys().json +++ b/docs/data/documentation/bodega/diskstorageengine/allkeys().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the keys contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/allkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" to find all of the keys."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"title":"allKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC7allKeysSayAA8CacheKeyVGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the keys contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/allkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" to find all of the keys."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"title":"allKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC7allKeysSayAA8CacheKeyVGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/createdat(key:).json b/docs/data/documentation/bodega/diskstorageengine/createdat(key:).json index a5db859..f05ea87 100644 --- a/docs/data/documentation/bodega/diskstorageengine/createdat(key:).json +++ b/docs/data/documentation/bodega/diskstorageengine/createdat(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The creation date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/createdat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the date of creation for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"createdAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC9createdAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The creation date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/createdat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the date of creation for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"createdAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC9createdAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/keycount().json b/docs/data/documentation/bodega/diskstorageengine/keycount().json index 6ad4cac..4a64394 100644 --- a/docs/data/documentation/bodega/diskstorageengine/keycount().json +++ b/docs/data/documentation/bodega/diskstorageengine/keycount().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The file\/key count."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"title":"keyCount()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC8keyCountSiyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keycount()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The file\/key count."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"title":"keyCount()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC8keyCountSiyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keycount()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/keyexists(_:).json b/docs/data/documentation/bodega/diskstorageengine/keyexists(_:).json index a77d7ef..e34842a 100644 --- a/docs/data/documentation/bodega/diskstorageengine/keyexists(_:).json +++ b/docs/data/documentation/bodega/diskstorageengine/keyexists(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the key exists the function returns true, false if it does not."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to for existence."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/keyexists(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"keyExists(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC9keyExistsySbAA8CacheKeyVF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the key exists the function returns true, false if it does not."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to for existence."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/keyexists(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"keyExists(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC9keyExistsySbAA8CacheKeyVF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/lastaccessed(key:).json b/docs/data/documentation/bodega/diskstorageengine/lastaccessed(key:).json index 7c5b15d..1ba7558 100644 --- a/docs/data/documentation/bodega/diskstorageengine/lastaccessed(key:).json +++ b/docs/data/documentation/bodega/diskstorageengine/lastaccessed(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The last access date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/lastaccessed(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the last access date of the file for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"lastAccessed(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC12lastAccessed3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/lastAccessed(key:)":{"role":"symbol","title":"lastAccessed(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the last access date of the file for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/lastaccessed(key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The last access date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/lastaccessed(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the last access date of the file for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"lastAccessed(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC12lastAccessed3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/lastAccessed(key:)":{"role":"symbol","title":"lastAccessed(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastAccessed"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the last access date of the file for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/lastAccessed(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/lastaccessed(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/read(key:).json b/docs/data/documentation/bodega/diskstorageengine/read(key:).json index 4d70bac..ee9ce79 100644 --- a/docs/data/documentation/bodega/diskstorageengine/read(key:).json +++ b/docs/data/documentation/bodega/diskstorageengine/read(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/read(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"title":"read(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC4read3key10Foundation4DataVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(key:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/read(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"title":"read(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC4read3key10Foundation4DataVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/read(keys:).json b/docs/data/documentation/bodega/diskstorageengine/read(keys:).json index 3945981..1465945 100644 --- a/docs/data/documentation/bodega/diskstorageengine/read(keys:).json +++ b/docs/data/documentation/bodega/diskstorageengine/read(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" stored on disk if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/read(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tYaF::SYNTHESIZED::s:6Bodega17DiskStorageEngineC","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/StorageEngine-Implementations":{"role":"collectionGroup","title":"StorageEngine Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" stored on disk if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/read(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tYaF::SYNTHESIZED::s:6Bodega17DiskStorageEngineC","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/StorageEngine-Implementations":{"role":"collectionGroup","title":"StorageEngine Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/readalldata().json b/docs/data/documentation/bodega/diskstorageengine/readalldata().json index 507e90f..53ec7c0 100644 --- a/docs/data/documentation/bodega/diskstorageengine/readalldata().json +++ b/docs/data/documentation/bodega/diskstorageengine/readalldata().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" contained on disk."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/readalldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"title":"readAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC11readAllDataSay10Foundation0G0VGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" contained on disk."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/readalldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"title":"readAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC11readAllDataSay10Foundation0G0VGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldata()"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/readalldataandkeys().json b/docs/data/documentation/bodega/diskstorageengine/readalldataandkeys().json index 65b413e..18c0b64 100644 --- a/docs/data/documentation/bodega/diskstorageengine/readalldataandkeys().json +++ b/docs/data/documentation/bodega/diskstorageengine/readalldataandkeys().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" and it’s associated "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s contained in a directory."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/readalldataandkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readAllDataAndKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0G0V4datatGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldataandkeys()"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" and it’s associated "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s contained in a directory."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/readalldataandkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readAllDataAndKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0G0V4datatGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldataandkeys()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readalldata()"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/readdataandkeys(keys:).json b/docs/data/documentation/bodega/diskstorageengine/readdataandkeys(keys:).json index 1ff5575..1a1e7f6 100644 --- a/docs/data/documentation/bodega/diskstorageengine/readdataandkeys(keys:).json +++ b/docs/data/documentation/bodega/diskstorageengine/readdataandkeys(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" read from disk if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an empty array if there are no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/readdataandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readDataAndKeys(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC15readDataAndKeys4keysSayAA8CacheKeyV3key_10Foundation0F0V4datatGSayAGG_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(keys:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" read from disk if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an empty array if there are no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/readdataandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readDataAndKeys(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC15readDataAndKeys4keysSayAA8CacheKeyV3key_10Foundation0F0V4datatGSayAGG_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/remove(key:).json b/docs/data/documentation/bodega/diskstorageengine/remove(key:).json index 7773990..19fc67a 100644 --- a/docs/data/documentation/bodega/diskstorageengine/remove(key:).json +++ b/docs/data/documentation/bodega/diskstorageengine/remove(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/remove(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"remove(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC6remove3keyyAA8CacheKeyV_tKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/remove(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"remove(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC6remove3keyyAA8CacheKeyV_tKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/remove(keys:).json b/docs/data/documentation/bodega/diskstorageengine/remove(keys:).json index d31fa79..cf37d70 100644 --- a/docs/data/documentation/bodega/diskstorageengine/remove(keys:).json +++ b/docs/data/documentation/bodega/diskstorageengine/remove(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/remove(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE6remove4keysySayAA8CacheKeyVG_tYaKF::SYNTHESIZED::s:6Bodega17DiskStorageEngineC","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/StorageEngine-Implementations":{"role":"collectionGroup","title":"StorageEngine Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/remove(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE6remove4keysySayAA8CacheKeyVG_tYaKF::SYNTHESIZED::s:6Bodega17DiskStorageEngineC","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/StorageEngine-Implementations":{"role":"collectionGroup","title":"StorageEngine Implementations","abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","kind":"article","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/removealldata().json b/docs/data/documentation/bodega/diskstorageengine/removealldata().json index 324f3fa..a0efffd 100644 --- a/docs/data/documentation/bodega/diskstorageengine/removealldata().json +++ b/docs/data/documentation/bodega/diskstorageengine/removealldata().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/removealldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"title":"removeAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC13removeAllDatayyKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/removealldata()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/removealldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"title":"removeAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC13removeAllDatayyKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items located in the "},{"type":"codeVoice","code":"directory"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/removealldata()"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/storageengine-implementations.json b/docs/data/documentation/bodega/diskstorageengine/storageengine-implementations.json index 6356d81..5edc95d 100644 --- a/docs/data/documentation/bodega/diskstorageengine/storageengine-implementations.json +++ b/docs/data/documentation/bodega/diskstorageengine/storageengine-implementations.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"article","metadata":{"modules":[{"name":"Bodega"}],"role":"collectionGroup","title":"StorageEngine Implementations"},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)"],"generated":true}],"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/storageengine-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/StorageEngine-Implementations","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"article","metadata":{"modules":[{"name":"Bodega"}],"role":"collectionGroup","title":"StorageEngine Implementations"},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)"],"generated":true}],"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/updatedat(key:).json b/docs/data/documentation/bodega/diskstorageengine/updatedat(key:).json index 514b704..d8263e0 100644 --- a/docs/data/documentation/bodega/diskstorageengine/updatedat(key:).json +++ b/docs/data/documentation/bodega/diskstorageengine/updatedat(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The updatedAt date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/updatedat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the updatedAt date for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"updatedAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC9updatedAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the updatedAt date for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The updatedAt date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/updatedat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the updatedAt date for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"updatedAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC9updatedAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the updatedAt date for the file represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/write(_:).json b/docs/data/documentation/bodega/diskstorageengine/write(_:).json index b9afec5..f4b2aca 100644 --- a/docs/data/documentation/bodega/diskstorageengine/write(_:).json +++ b/docs/data/documentation/bodega/diskstorageengine/write(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"dataAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"dataAndKeys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" to store"},{"type":"text","text":" "},{"type":"text","text":"multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items with their associated keys at once."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/write(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"title":"write(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC5writeyySayAA8CacheKeyV3key_10Foundation4DataV4datatGKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"dataAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"dataAndKeys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" to store"},{"type":"text","text":" "},{"type":"text","text":"multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items with their associated keys at once."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/write(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"title":"write(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC5writeyySayAA8CacheKeyV3key_10Foundation4DataV4datatGKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/diskstorageengine/write(_:key:).json b/docs/data/documentation/bodega/diskstorageengine/write(_:key:).json index d3b1871..8bb47b8 100644 --- a/docs/data/documentation/bodega/diskstorageengine/write(_:key:).json +++ b/docs/data/documentation/bodega/diskstorageengine/write(_:key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being stored to disk."}]}]},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/write(_:key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"write(_:key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC5write_3keyy10Foundation4DataV_AA8CacheKeyVtKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being stored to disk."}]}]},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to a location on disk."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/diskstorageengine\/write(_:key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"write(_:key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega17DiskStorageEngineC5write_3keyy10Foundation4DataV_AA8CacheKeyVtKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/diskstorageengine\/write(_:key:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage.json b/docs/data/documentation/bodega/objectstorage.json index 6629e24..1a0a389 100644 --- a/docs/data/documentation/bodega/objectstorage.json +++ b/docs/data/documentation/bodega/objectstorage.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"actor"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"Object"},{"kind":"text","text":"> "},{"kind":"keyword","text":"where"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Decodable","preciseIdentifier":"s:Se"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Encodable","preciseIdentifier":"s:SE"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is a higher level abstraction than a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you"},{"type":"text","text":" "},{"type":"text","text":"to interact with Swift objects, never thinking about the persistence layer that’s saving"},{"type":"text","text":" "},{"type":"text","text":"objects under the hood."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is a safe, fast, and easy database to based on SQLite,"},{"type":"text","text":" "},{"type":"text","text":"but if you prefer to use your own persistence layer or want to save your objects"},{"type":"text","text":" "},{"type":"text","text":"to another location, you can use the "},{"type":"codeVoice","code":"storage"},{"type":"text","text":" parameter like so"}]},{"type":"codeListing","syntax":null,"code":["SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Assets\"))"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"title":"ObjectStorage","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:6Bodega13ObjectStorageC","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)"]}],"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/updatedAt(forKey:)":{"role":"symbol","title":"updatedAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/updatedat(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/objectsAndKeys(keys:)":{"role":"symbol","title":"objectsAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objectsandkeys(keys:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/init(storage:)":{"role":"symbol","title":"init(storage:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" object for persisting "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/init(storage:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/objects(forKeys:)":{"role":"symbol","title":"objects(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objects(forkeys:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKey:)":{"role":"symbol","title":"removeObject(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjects()":{"role":"symbol","title":"allObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjects()"},"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:)":{"role":"symbol","title":"store(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:)"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"},"doc://Bodega/documentation/Bodega/ObjectStorage/object(forKey:)":{"role":"symbol","title":"object(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/object(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeAllObjects()":{"role":"symbol","title":"removeAllObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeallobjects()"},"doc://Bodega/documentation/Bodega/ObjectStorage/createdAt(forKey:)":{"role":"symbol","title":"createdAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/createdat(forkey:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/keycount()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjectsAndKeys()":{"role":"symbol","title":"allObjectsAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all of the objects and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjectsandkeys()"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKeys:)":{"role":"symbol","title":"removeObject(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s from the underlying Storage based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkeys:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:forKey:)":{"role":"symbol","title":"store(_:forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to find all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allkeys()"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"actor"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"Object"},{"kind":"text","text":"> "},{"kind":"keyword","text":"where"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Decodable","preciseIdentifier":"s:Se"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Encodable","preciseIdentifier":"s:SE"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is a higher level abstraction than a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you"},{"type":"text","text":" "},{"type":"text","text":"to interact with Swift objects, never thinking about the persistence layer that’s saving"},{"type":"text","text":" "},{"type":"text","text":"objects under the hood."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is a safe, fast, and easy database to based on SQLite,"},{"type":"text","text":" "},{"type":"text","text":"but if you prefer to use your own persistence layer or want to save your objects"},{"type":"text","text":" "},{"type":"text","text":"to another location, you can use the "},{"type":"codeVoice","code":"storage"},{"type":"text","text":" parameter like so"}]},{"type":"codeListing","syntax":null,"code":["SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Assets\"))"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"title":"ObjectStorage","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:6Bodega13ObjectStorageC","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)"]}],"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/updatedAt(forKey:)":{"role":"symbol","title":"updatedAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/updatedat(forkey:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKey:)":{"role":"symbol","title":"removeObject(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkey:)"},"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjectsAndKeys()":{"role":"symbol","title":"allObjectsAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all of the objects and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjectsandkeys()"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeAllObjects()":{"role":"symbol","title":"removeAllObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeallobjects()"},"doc://Bodega/documentation/Bodega/ObjectStorage/init(storage:)":{"role":"symbol","title":"init(storage:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" object for persisting "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/init(storage:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjects()":{"role":"symbol","title":"allObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjects()"},"doc://Bodega/documentation/Bodega/ObjectStorage/objects(forKeys:)":{"role":"symbol","title":"objects(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objects(forkeys:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage/objectsAndKeys(keys:)":{"role":"symbol","title":"objectsAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objectsandkeys(keys:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKeys:)":{"role":"symbol","title":"removeObject(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s from the underlying Storage based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkeys:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/object(forKey:)":{"role":"symbol","title":"object(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/object(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:)":{"role":"symbol","title":"store(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/keycount()"},"doc://Bodega/documentation/Bodega/ObjectStorage/createdAt(forKey:)":{"role":"symbol","title":"createdAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/createdat(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to find all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allkeys()"},"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:forKey:)":{"role":"symbol","title":"store(_:forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:forkey:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/allkeys().json b/docs/data/documentation/bodega/objectstorage/allkeys().json index c9c4544..ce95b33 100644 --- a/docs/data/documentation/bodega/objectstorage/allkeys().json +++ b/docs/data/documentation/bodega/objectstorage/allkeys().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the keys contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/allkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to find all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s keys."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"title":"allKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC7allKeysSayAA8CacheKeyVGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to find all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allkeys()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the keys contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/allkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to find all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s keys."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"title":"allKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC7allKeysSayAA8CacheKeyVGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to find all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allkeys()"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/allobjects().json b/docs/data/documentation/bodega/objectstorage/allobjects().json index 126d369..f807d0b 100644 --- a/docs/data/documentation/bodega/objectstorage/allobjects().json +++ b/docs/data/documentation/bodega/objectstorage/allobjects().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/allobjects()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"title":"allObjects()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC10allObjectsSayxGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjects()":{"role":"symbol","title":"allObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjects()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/allobjects()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"title":"allObjects()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC10allObjectsSayxGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjects()":{"role":"symbol","title":"allObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjects()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/allobjectsandkeys().json b/docs/data/documentation/bodega/objectstorage/allobjectsandkeys().json index d7c0055..75f89c6 100644 --- a/docs/data/documentation/bodega/objectstorage/allobjectsandkeys().json +++ b/docs/data/documentation/bodega/objectstorage/allobjectsandkeys().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s and it’s associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s contained in a directory."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s, but if you"},{"type":"text","text":" "},{"type":"text","text":"don’t need to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/allobjectsandkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all of the objects and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"title":"allObjectsAndKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC17allObjectsAndKeysSayAA8CacheKeyV3key_x6objecttGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjectsAndKeys()":{"role":"symbol","title":"allObjectsAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all of the objects and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjectsandkeys()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjects()":{"role":"symbol","title":"allObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjects()"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s and it’s associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s contained in a directory."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s, but if you"},{"type":"text","text":" "},{"type":"text","text":"don’t need to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/allobjectsandkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all of the objects and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"title":"allObjectsAndKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC17allObjectsAndKeysSayAA8CacheKeyV3key_x6objecttGyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjects()":{"role":"symbol","title":"allObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":" objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjects()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/allObjectsAndKeys()":{"role":"symbol","title":"allObjectsAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allObjectsAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all of the objects and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/allObjectsAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/allobjectsandkeys()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/createdat(forkey:).json b/docs/data/documentation/bodega/objectstorage/createdat(forkey:).json index 08b14fa..d1080fc 100644 --- a/docs/data/documentation/bodega/objectstorage/createdat(forkey:).json +++ b/docs/data/documentation/bodega/objectstorage/createdat(forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The creation date of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" if it exists, nil if there is no "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/createdat(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the date of creation for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"createdAt(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC9createdAt6forKey10Foundation4DateVSgAA05CacheG0V_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/createdAt(forKey:)":{"role":"symbol","title":"createdAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/createdat(forkey:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The creation date of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" if it exists, nil if there is no "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/createdat(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the date of creation for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"createdAt(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC9createdAt6forKey10Foundation4DateVSgAA05CacheG0V_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/createdAt(forKey:)":{"role":"symbol","title":"createdAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/createdAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/createdat(forkey:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/init(storage:).json b/docs/data/documentation/bodega/objectstorage/init(storage:).json index f064c95..30b5ffd 100644 --- a/docs/data/documentation/bodega/objectstorage/init(storage:).json +++ b/docs/data/documentation/bodega/objectstorage/init(storage:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP","text":"StorageEngine"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"storage","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" to initialize an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" instance with."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/init(storage:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" object for persisting "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP"},{"kind":"text","text":")"}],"title":"init(storage:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega13ObjectStorageC7storageACyxGAA0C6Engine_p_tcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/init(storage:)":{"role":"symbol","title":"init(storage:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" object for persisting "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/init(storage:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP","text":"StorageEngine"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"storage","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" to initialize an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" instance with."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/init(storage:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" object for persisting "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP"},{"kind":"text","text":")"}],"title":"init(storage:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega13ObjectStorageC7storageACyxGAA0C6Engine_p_tcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/init(storage:)":{"role":"symbol","title":"init(storage:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"StorageEngine","preciseIdentifier":"s:6Bodega13StorageEngineP"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" object for persisting "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/init(storage:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/init(storage:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/keycount().json b/docs/data/documentation/bodega/objectstorage/keycount().json index 08af8b1..b867ab7 100644 --- a/docs/data/documentation/bodega/objectstorage/keycount().json +++ b/docs/data/documentation/bodega/objectstorage/keycount().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The object\/key count."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of objects."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"title":"keyCount()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC8keyCountSiyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/keycount()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The object\/key count."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of objects."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"title":"keyCount()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC8keyCountSiyYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through a directory to find the total number of objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/keycount()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/object(forkey:).json b/docs/data/documentation/bodega/objectstorage/object(forkey:).json index a42a8b1..8935661 100644 --- a/docs/data/documentation/bodega/objectstorage/object(forkey:).json +++ b/docs/data/documentation/bodega/objectstorage/object(forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The object stored if it exists, nil if there is no "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/object(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"title":"object(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC6object6forKeyxSgAA05CacheF0V_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/object(forKey:)":{"role":"symbol","title":"object(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/object(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The object stored if it exists, nil if there is no "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/object(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"title":"object(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC6object6forKeyxSgAA05CacheF0V_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage/object(forKey:)":{"role":"symbol","title":"object(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"object"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/object(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/object(forkey:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/objects(forkeys:).json b/docs/data/documentation/bodega/objectstorage/objects(forkeys:).json index d11366a..0dc2aee 100644 --- a/docs/data/documentation/bodega/objectstorage/objects(forkeys:).json +++ b/docs/data/documentation/bodega/objectstorage/objects(forkeys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":" "},{"kind":"internalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s stored if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there are no "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/objects(forkeys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"title":"objects(forKeys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC7objects7forKeysSayxGSayAA8CacheKeyVG_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/objects(forKeys:)":{"role":"symbol","title":"objects(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objects(forkeys:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":" "},{"kind":"internalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s stored if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there are no "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/objects(forkeys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"title":"objects(forKeys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC7objects7forKeysSayxGSayAA8CacheKeyVG_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/objects(forKeys:)":{"role":"symbol","title":"objects(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objects(forkeys:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/objectsandkeys(keys:).json b/docs/data/documentation/bodega/objectstorage/objectsandkeys(keys:).json index c65a718..3462ddc 100644 --- a/docs/data/documentation/bodega/objectstorage/objectsandkeys(keys:).json +++ b/docs/data/documentation/bodega/objectstorage/objectsandkeys(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" read if it exists,"},{"type":"text","text":" "},{"type":"text","text":"and an empty array if there are no "},{"type":"codeVoice","code":"Objects"},{"type":"text","text":"s matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s, but if you don’t need to know"},{"type":"text","text":" "},{"type":"text","text":"which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" being retrieved you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/objectsandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"title":"objectsAndKeys(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC14objectsAndKeys4keysSayAA8CacheKeyV3key_x6objecttGSayAGG_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/objectsAndKeys(keys:)":{"role":"symbol","title":"objectsAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objectsandkeys(keys:)"},"doc://Bodega/documentation/Bodega/ObjectStorage/objects(forKeys:)":{"role":"symbol","title":"objects(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objects(forkeys:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" read if it exists,"},{"type":"text","text":" "},{"type":"text","text":"and an empty array if there are no "},{"type":"codeVoice","code":"Objects"},{"type":"text","text":"s matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s, but if you don’t need to know"},{"type":"text","text":" "},{"type":"text","text":"which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" being retrieved you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/objectsandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"title":"objectsAndKeys(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC14objectsAndKeys4keysSayAA8CacheKeyV3key_x6objecttGSayAGG_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/objects(forKeys:)":{"role":"symbol","title":"objects(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objects"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objects(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objects(forkeys:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/objectsAndKeys(keys:)":{"role":"symbol","title":"objectsAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"objectsAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter"},{"type":"text","text":" "},{"type":"text","text":"and returns an array "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" associated with the passed in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/objectsAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/objectsandkeys(keys:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/removeallobjects().json b/docs/data/documentation/bodega/objectstorage/removeallobjects().json index 811b902..f68ac78 100644 --- a/docs/data/documentation/bodega/objectstorage/removeallobjects().json +++ b/docs/data/documentation/bodega/objectstorage/removeallobjects().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/removeallobjects()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"removeAllObjects()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC16removeAllObjectsyyYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/removeAllObjects()":{"role":"symbol","title":"removeAllObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeallobjects()"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/removeallobjects()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"removeAllObjects()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC16removeAllObjectsyyYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeAllObjects()":{"role":"symbol","title":"removeAllObjects()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllObjects"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all of the "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeAllObjects()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeallobjects()"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/removeobject(forkey:).json b/docs/data/documentation/bodega/objectstorage/removeobject(forkey:).json index 26c10e6..549af35 100644 --- a/docs/data/documentation/bodega/objectstorage/removeobject(forkey:).json +++ b/docs/data/documentation/bodega/objectstorage/removeobject(forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/removeobject(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"removeObject(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC06removeB06forKeyyAA05CacheF0V_tYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKey:)":{"role":"symbol","title":"removeObject(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/removeobject(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"removeObject(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC06removeB06forKeyyAA05CacheF0V_tYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKey:)":{"role":"symbol","title":"removeObject(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkey:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/removeobject(forkeys:).json b/docs/data/documentation/bodega/objectstorage/removeobject(forkeys:).json index 884cabb..eac4d0b 100644 --- a/docs/data/documentation/bodega/objectstorage/removeobject(forkeys:).json +++ b/docs/data/documentation/bodega/objectstorage/removeobject(forkeys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":" "},{"kind":"internalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/removeobject(forkeys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s from the underlying Storage based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"removeObject(forKeys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC06removeB07forKeysySayAA8CacheKeyVG_tYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKeys:)":{"role":"symbol","title":"removeObject(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s from the underlying Storage based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkeys:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":" "},{"kind":"internalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"s."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/removeobject(forkeys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s from the underlying Storage based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"removeObject(forKeys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC06removeB07forKeysySayAA8CacheKeyVG_tYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/removeObject(forKeys:)":{"role":"symbol","title":"removeObject(forKeys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeObject"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKeys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s from the underlying Storage based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/removeObject(forKeys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/removeobject(forkeys:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/store(_:).json b/docs/data/documentation/bodega/objectstorage/store(_:).json index 57f31a8..efc0677 100644 --- a/docs/data/documentation/bodega/objectstorage/store(_:).json +++ b/docs/data/documentation/bodega/objectstorage/store(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"objectsAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"objectsAndKeys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" to store"},{"type":"text","text":" "},{"type":"text","text":"multiple objects with their associated keys at once."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/store(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"store(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC5storeyySayAA8CacheKeyV3key_x6objecttGYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:)":{"role":"symbol","title":"store(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"objectsAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"objectsAndKeys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Object)]"},{"type":"text","text":" to store"},{"type":"text","text":" "},{"type":"text","text":"multiple objects with their associated keys at once."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/store(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"store(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC5storeyySayAA8CacheKeyV3key_x6objecttGYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:)":{"role":"symbol","title":"store(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"[Object]"},{"type":"text","text":"s based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" passed in the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/store(_:forkey:).json b/docs/data/documentation/bodega/objectstorage/store(_:forkey:).json index ead1d6b..c0eba20 100644 --- a/docs/data/documentation/bodega/objectstorage/store(_:forkey:).json +++ b/docs/data/documentation/bodega/objectstorage/store(_:forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"object","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The object being stored."}]}]},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/store(_:forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"store(_:forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC5store_6forKeyyx_AA05CacheF0VtYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:forKey:)":{"role":"symbol","title":"store(_:forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:forkey:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"object"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"object","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The object being stored."}]}]},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/store(_:forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"store(_:forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC5store_6forKeyyx_AA05CacheF0VtYaKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/store(_:forKey:)":{"role":"symbol","title":"store(_:forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Object"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":" based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/store(_:forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/store(_:forkey:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/objectstorage/updatedat(forkey:).json b/docs/data/documentation/bodega/objectstorage/updatedat(forkey:).json index cad1f60..a4a7141 100644 --- a/docs/data/documentation/bodega/objectstorage/updatedat(forkey:).json +++ b/docs/data/documentation/bodega/objectstorage/updatedat(forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The modification date of the object if it exists, nil if there is no object stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/updatedat(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the modification date for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"updatedAt(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC9updatedAt6forKey10Foundation4DateVSgAA05CacheG0V_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage/updatedAt(forKey:)":{"role":"symbol","title":"updatedAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/updatedat(forkey:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The modification date of the object if it exists, nil if there is no object stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching an "},{"type":"codeVoice","code":"Object"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/objectstorage\/updatedat(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the modification date for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"updatedAt(forKey:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega13ObjectStorageC9updatedAt6forKey10Foundation4DateVSgAA05CacheG0V_tYaF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/ObjectStorage/updatedAt(forKey:)":{"role":"symbol","title":"updatedAt(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the object represented by the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage\/updatedAt(forKey:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/objectstorage\/updatedat(forkey:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine.json b/docs/data/documentation/bodega/sqlitestorageengine.json index 14d43dc..f1b6de7 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine.json +++ b/docs/data/documentation/bodega/sqlitestorageengine.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"actor"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is significantly faster than "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" because it uses SQLite"},{"type":"text","text":" "},{"type":"text","text":"rather than saving files to disk. As much as "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" was optimized, file system operations"},{"type":"text","text":" "},{"type":"text","text":"like reading, writing, and removing files have a relatively high cost per operation, and SQLite"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html"},{"type":"text","text":" to be significantly faster than files for storing data."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you’re not using your own persistence mechanism such as Realm, Core Data, etc,"},{"type":"text","text":" "},{"type":"text","text":"it is highly recommended you use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" to power your "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"When initializing a database there is a possibility that the database Connection will fail."},{"type":"text","text":" "},{"type":"text","text":"There isn’t much reason to expect this, but it is a possibility so this initializer returns an optional."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Generally creating implicitly unwrapped optionals is frowned upon, but it’s worth asking"},{"type":"text","text":" "},{"type":"text","text":"what will happen if you use one when initializing a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Code like this may look dangerous at first glance because of the "},{"type":"codeVoice","code":"!"},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"but if that database is storing important data and fails to initialize"},{"type":"text","text":" "},{"type":"text","text":"then the app will likely not function as the user expects."}]},{"type":"codeListing","syntax":null,"code":["let storageEngine = SQLiteStorageEngine(directory: .documents(appending: \"Notes))!"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The alternate experience is to continue running the app with a database not capable of saving data,"},{"type":"text","text":" "},{"type":"text","text":"an equally bad if not more confusing experience for a user."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"One alternative is to make the initializer "},{"type":"codeVoice","code":"throw"},{"type":"text","text":", and that’s a perfectly reasonable tradeoff."},{"type":"text","text":" "},{"type":"text","text":"While that is doable, I believe it’s very unlikely the caller will have specific remedies for"},{"type":"text","text":" "},{"type":"text","text":"specific SQLite errors, so for simplicity I’ve made the initializer return an optional "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"title":"SQLiteStorageEngine","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:6Bodega19SQLiteStorageEngineC","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)"]},{"title":"Type Properties","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default"]},{"title":"Type Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)"]}],"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/removealldata()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the database and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldataandkeys()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through the database to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keycount()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/init(directory:databaseFilename:)":{"role":"symbol","title":"init(directory:databaseFilename:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/init(directory:databasefilename:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default(appendingPath:)":{"role":"symbol","title":"default(appendingPath:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default(appendingpath:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the database to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to the database with their associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:)"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the database with an associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default":{"role":"symbol","title":"default","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"},"https://www.sqlite.org/fasterthanfs.html":{"title":"has been shown","titleInlineContent":[{"type":"text","text":"has been shown"}],"type":"link","identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html","url":"https:\/\/www.sqlite.org\/fasterthanfs.html"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"actor"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is significantly faster than "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" because it uses SQLite"},{"type":"text","text":" "},{"type":"text","text":"rather than saving files to disk. As much as "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" was optimized, file system operations"},{"type":"text","text":" "},{"type":"text","text":"like reading, writing, and removing files have a relatively high cost per operation, and SQLite"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html"},{"type":"text","text":" to be significantly faster than files for storing data."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you’re not using your own persistence mechanism such as Realm, Core Data, etc,"},{"type":"text","text":" "},{"type":"text","text":"it is highly recommended you use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" to power your "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"When initializing a database there is a possibility that the database Connection will fail."},{"type":"text","text":" "},{"type":"text","text":"There isn’t much reason to expect this, but it is a possibility so this initializer returns an optional."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Generally creating implicitly unwrapped optionals is frowned upon, but it’s worth asking"},{"type":"text","text":" "},{"type":"text","text":"what will happen if you use one when initializing a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Code like this may look dangerous at first glance because of the "},{"type":"codeVoice","code":"!"},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"but if that database is storing important data and fails to initialize"},{"type":"text","text":" "},{"type":"text","text":"then the app will likely not function as the user expects."}]},{"type":"codeListing","syntax":null,"code":["let storageEngine = SQLiteStorageEngine(directory: .documents(appending: \"Notes))!"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The alternate experience is to continue running the app with a database not capable of saving data,"},{"type":"text","text":" "},{"type":"text","text":"an equally bad if not more confusing experience for a user."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"One alternative is to make the initializer "},{"type":"codeVoice","code":"throw"},{"type":"text","text":", and that’s a perfectly reasonable tradeoff."},{"type":"text","text":" "},{"type":"text","text":"While that is doable, I believe it’s very unlikely the caller will have specific remedies for"},{"type":"text","text":" "},{"type":"text","text":"specific SQLite errors, so for simplicity I’ve made the initializer return an optional "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"title":"SQLiteStorageEngine","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:6Bodega19SQLiteStorageEngineC","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)"]},{"title":"Type Properties","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default"]},{"title":"Type Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)"]}],"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the database to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default":{"role":"symbol","title":"default","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readdataandkeys(keys:)"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through the database to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keycount()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default(appendingPath:)":{"role":"symbol","title":"default(appendingPath:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default(appendingpath:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"https://www.sqlite.org/fasterthanfs.html":{"title":"has been shown","titleInlineContent":[{"type":"text","text":"has been shown"}],"type":"link","identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html","url":"https:\/\/www.sqlite.org\/fasterthanfs.html"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/removealldata()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the database with an associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the database and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldataandkeys()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to the database with their associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/updatedat(key:)"},"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/init(directory:databaseFilename:)":{"role":"symbol","title":"init(directory:databaseFilename:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/init(directory:databasefilename:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/allkeys().json b/docs/data/documentation/bodega/sqlitestorageengine/allkeys().json index e69fb20..2173ccd 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/allkeys().json +++ b/docs/data/documentation/bodega/sqlitestorageengine/allkeys().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the keys contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/allkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through the database to find all of the keys."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"title":"allKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC7allKeysSayAA8CacheKeyVGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the database to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the keys contained in a directory."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/allkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through the database to find all of the keys."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"title":"allKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC7allKeysSayAA8CacheKeyVGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Iterates through the database to find all of the keys."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/allKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/createdat(key:).json b/docs/data/documentation/bodega/sqlitestorageengine/createdat(key:).json index 04053ed..b056269 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/createdat(key:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/createdat(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The creation date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/createdat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the date of creation for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"createdAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC9createdAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The creation date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/createdat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the date of creation for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"createdAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC9createdAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the date of creation for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/createdAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/default(appendingpath:).json b/docs/data/documentation/bodega/sqlitestorageengine/default(appendingpath:).json index fe2de67..31eb212 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/default(appendingpath:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/default(appendingpath:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":" "},{"kind":"internalParam","text":"pathComponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC","text":"SQLiteStorageEngine"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"pathComponent","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The path to append to the platform-specific defatult storage directory."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Equivalent to:"},{"type":"text","text":" "},{"type":"codeVoice","code":"SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Your Path\"))"}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/default(appendingpath:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"kind":"symbol","metadata":{"role":"symbol","title":"default(appendingPath:)","roleHeading":"Type Method","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC7default13appendingPathACSS_tFZ","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default(appendingPath:)":{"role":"symbol","title":"default(appendingPath:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default(appendingpath:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":" "},{"kind":"internalParam","text":"pathComponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC","text":"SQLiteStorageEngine"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"pathComponent","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The path to append to the platform-specific defatult storage directory."}]}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Equivalent to:"},{"type":"text","text":" "},{"type":"codeVoice","code":"SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Your Path\"))"}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/default(appendingpath:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"kind":"symbol","metadata":{"role":"symbol","title":"default(appendingPath:)","roleHeading":"Type Method","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC7default13appendingPathACSS_tFZ","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default(appendingPath:)":{"role":"symbol","title":"default(appendingPath:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appendingPath"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default(appendingPath:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default(appendingpath:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/default.json b/docs/data/documentation/bodega/sqlitestorageengine/default.json index e3558af..786391b 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/default.json +++ b/docs/data/documentation/bodega/sqlitestorageengine/default.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC","text":"SQLiteStorageEngine"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Equivalent to:"},{"type":"text","text":" "},{"type":"codeVoice","code":"SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Data\"))"}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/default"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"kind":"symbol","metadata":{"role":"symbol","title":"default","roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"symbolKind":"property","externalID":"s:6Bodega19SQLiteStorageEngineC7defaultACvpZ","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default":{"role":"symbol","title":"default","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC","text":"SQLiteStorageEngine"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Equivalent to:"},{"type":"text","text":" "},{"type":"codeVoice","code":"SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Data\"))"}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/default"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"kind":"symbol","metadata":{"role":"symbol","title":"default","roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"symbolKind":"property","externalID":"s:6Bodega19SQLiteStorageEngineC7defaultACvpZ","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/default":{"role":"symbol","title":"default","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SQLiteStorageEngine","preciseIdentifier":"s:6Bodega19SQLiteStorageEngineC"}],"abstract":[{"type":"text","text":"An "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" located in the platform-specific default storage directory."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/default","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/default"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/init(directory:databasefilename:).json b/docs/data/documentation/bodega/sqlitestorageengine/init(directory:databasefilename:).json index 792e848..2b71055 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/init(directory:databasefilename:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/init(directory:databasefilename:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"data\")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"directory","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A directory on the filesystem where your files will be written to."},{"type":"text","text":" "},{"type":"codeVoice","code":"FileManager.Directory"},{"type":"text","text":" is a type-safe wrapper around URL that provides sensible defaults like"},{"type":"text","text":" "},{"type":"codeVoice","code":".documents(appendingPath:)"},{"type":"text","text":", "},{"type":"codeVoice","code":".caches(appendingPath:)"},{"type":"text","text":", and more."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/init(directory:databasefilename:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"title":"init(directory:databaseFilename:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega19SQLiteStorageEngineC9directory16databaseFilenameACSgSo13NSFileManagerCAAE9DirectoryV_SStcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/init(directory:databaseFilename:)":{"role":"symbol","title":"init(directory:databaseFilename:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/init(directory:databasefilename:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"data\")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"directory","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A directory on the filesystem where your files will be written to."},{"type":"text","text":" "},{"type":"codeVoice","code":"FileManager.Directory"},{"type":"text","text":" is a type-safe wrapper around URL that provides sensible defaults like"},{"type":"text","text":" "},{"type":"codeVoice","code":".documents(appendingPath:)"},{"type":"text","text":", "},{"type":"codeVoice","code":".caches(appendingPath:)"},{"type":"text","text":", and more."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/init(directory:databasefilename:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"title":"init(directory:databaseFilename:)","roleHeading":"Initializer","role":"symbol","symbolKind":"init","externalID":"s:6Bodega19SQLiteStorageEngineC9directory16databaseFilenameACSgSo13NSFileManagerCAAE9DirectoryV_SStcfc","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/init(directory:databaseFilename:)":{"role":"symbol","title":"init(directory:databaseFilename:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Directory","preciseIdentifier":"s:So13NSFileManagerC6BodegaE9DirectoryV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"databaseFilename"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Initializes a new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" for persisting "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to disk."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/init(directory:databaseFilename:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/init(directory:databasefilename:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/keycount().json b/docs/data/documentation/bodega/sqlitestorageengine/keycount().json index 8f5f977..08e5b9d 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/keycount().json +++ b/docs/data/documentation/bodega/sqlitestorageengine/keycount().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The file\/key count."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through the database to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"title":"keyCount()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC8keyCountSiyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through the database to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keycount()"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The file\/key count."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Iterates through the database to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"title":"keyCount()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC8keyCountSiyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"Iterates through the database to find the total number of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyCount()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keycount()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/keyexists(_:).json b/docs/data/documentation/bodega/sqlitestorageengine/keyexists(_:).json index 20c4f56..e1fc67a 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/keyexists(_:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/keyexists(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the key exists the function returns true, false if it does not."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to for existence."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/keyexists(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"keyExists(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC9keyExistsySbAA8CacheKeyVF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the key exists the function returns true, false if it does not."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to for existence."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/keyexists(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"keyExists(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC9keyExistsySbAA8CacheKeyVF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Checks whether a value with a key is persisted."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/keyExists(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/read(key:).json b/docs/data/documentation/bodega/sqlitestorageengine/read(key:).json index cc9a9ad..68f225f 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/read(key:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/read(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/read(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"title":"read(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC4read3key10Foundation4DataVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/read(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"title":"read(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC4read3key10Foundation4DataVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/read(keys:).json b/docs/data/documentation/bodega/sqlitestorageengine/read(keys:).json index c5e12e0..c6f1954 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/read(keys:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/read(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" stored on disk if the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"title":"read(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" stored on disk if the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"title":"read(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/readalldata().json b/docs/data/documentation/bodega/sqlitestorageengine/readalldata().json index 9e023d0..a16d66a 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/readalldata().json +++ b/docs/data/documentation/bodega/sqlitestorageengine/readalldata().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" contained in the database."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/readalldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"title":"readAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC11readAllDataSay10Foundation0G0VGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" contained in the database."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/readalldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"title":"readAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC11readAllDataSay10Foundation0G0VGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/readalldataandkeys().json b/docs/data/documentation/bodega/sqlitestorageengine/readalldataandkeys().json index 3171a5f..764f8f4 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/readalldataandkeys().json +++ b/docs/data/documentation/bodega/sqlitestorageengine/readalldataandkeys().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" and it’s associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/readalldataandkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the database and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readAllDataAndKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0G0V4datatGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the database and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldataandkeys()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" and it’s associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/readalldataandkeys()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the database and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readAllDataAndKeys()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0G0V4datatGyF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllData()":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldata()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readAllDataAndKeys()":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the database and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readAllDataAndKeys()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readalldataandkeys()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/readdataandkeys(keys:).json b/docs/data/documentation/bodega/sqlitestorageengine/readdataandkeys(keys:).json index 6aea42a..0aa9db7 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/readdataandkeys(keys:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/readdataandkeys(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" if the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an empty array if there are no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/readdataandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readDataAndKeys(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC15readDataAndKeys4keysSayAA8CacheKeyV3key_10Foundation0F0V4datatGSayAGG_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readdataandkeys(keys:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" if the "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an empty array if there are no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/readdataandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"title":"readDataAndKeys(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC15readDataAndKeys4keysSayAA8CacheKeyV3key_10Foundation0F0V4datatGSayAGG_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in a tuple of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over data, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" that led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)"},{"type":"text","text":" instead."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/readDataAndKeys(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/read(keys:)":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/read(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/read(keys:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/remove(key:).json b/docs/data/documentation/bodega/sqlitestorageengine/remove(key:).json index f7eae4e..2c034d8 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/remove(key:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/remove(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for finding the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to remove."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/remove(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"remove(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC6remove3keyyAA8CacheKeyV_tKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for finding the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to remove."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/remove(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"remove(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC6remove3keyyAA8CacheKeyV_tKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from disk based on the associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/remove(keys:).json b/docs/data/documentation/bodega/sqlitestorageengine/remove(keys:).json index 9d016bb..33d31c2 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/remove(keys:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/remove(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to remove."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/remove(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"title":"remove(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC6remove4keysySayAA8CacheKeyVG_tKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to remove."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/remove(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"title":"remove(keys:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC6remove4keysySayAA8CacheKeyVG_tKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/remove(keys:)":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/remove(keys:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/remove(keys:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/removealldata().json b/docs/data/documentation/bodega/sqlitestorageengine/removealldata().json index 4167223..c4448ba 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/removealldata().json +++ b/docs/data/documentation/bodega/sqlitestorageengine/removealldata().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/removealldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"title":"removeAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC13removeAllDatayyKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/removealldata()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/removealldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"title":"removeAllData()","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC13removeAllDatayyKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items from the database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/removeAllData()","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/removealldata()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/updatedat(key:).json b/docs/data/documentation/bodega/sqlitestorageengine/updatedat(key:).json index bca7d9a..a5f8c22 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/updatedat(key:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/updatedat(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The modification date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/updatedat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the modification date for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"updatedAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC9updatedAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The modification date of the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" on disk if it exists, nil if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" stored for the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/updatedat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Returns the modification date for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"updatedAt(key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC9updatedAt3key10Foundation4DateVSgAA8CacheKeyV_tF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Returns the modification date for the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item matching the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":", if it exists."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/updatedAt(key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/write(_:).json b/docs/data/documentation/bodega/sqlitestorageengine/write(_:).json index d2f1049..69e0fd6 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/write(_:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/write(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"dataAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"dataAndKeys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" to store"},{"type":"text","text":" "},{"type":"text","text":"multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items with their associated keys at once."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/write(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to the database with their associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from the tuple."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"title":"write(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC5writeyySayAA8CacheKeyV3key_10Foundation4DataV4datatGKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to the database with their associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"dataAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"dataAndKeys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" to store"},{"type":"text","text":" "},{"type":"text","text":"multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items with their associated keys at once."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/write(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to the database with their associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from the tuple."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"title":"write(_:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC5writeyySayAA8CacheKeyV3key_10Foundation4DataV4datatGKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes an array of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items to the database with their associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" from the tuple."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/sqlitestorageengine/write(_:key:).json b/docs/data/documentation/bodega/sqlitestorageengine/write(_:key:).json index 64a00c9..e59215c 100644 --- a/docs/data/documentation/bodega/sqlitestorageengine/write(_:key:).json +++ b/docs/data/documentation/bodega/sqlitestorageengine/write(_:key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being stored to disk."}]}]},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/write(_:key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the database with an associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"write(_:key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC5write_3keyy10Foundation4DataV_AA8CacheKeyVtKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the database with an associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being stored to disk."}]}]},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" for matching "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/sqlitestorageengine\/write(_:key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the database with an associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"write(_:key:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:6Bodega19SQLiteStorageEngineC5write_3keyy10Foundation4DataV_AA8CacheKeyVtKF","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Writes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" to the database with an associated "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine\/write(_:key:)","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/sqlitestorageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine.json b/docs/data/documentation/bodega/storageengine.json index fe48261..caddb2a 100644 --- a/docs/data/documentation/bodega/storageengine.json +++ b/docs/data/documentation/bodega/storageengine.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Actor","preciseIdentifier":"s:ScA"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is a construct you can build that plugs into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" "},{"type":"text","text":"to use for persisting data."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This library has two implementations of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Both of these can serve as inspiration if you have your own persistence mechanism (such as Realm, CoreData, etc)."}]},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and saves it to disk using file system operations."},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and saves it to an SQLite database under the hood."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you have your own way of storing data then you can refer to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" "},{"type":"text","text":"for inspiration, but all you need to do is conform to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol"},{"type":"text","text":" "},{"type":"text","text":"and initialize "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" with that storage."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Inherits From","type":"inheritsFrom"},{"identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"],"kind":"relationships","title":"Conforming Types","type":"conformingTypes"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"title":"StorageEngine","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:6Bodega13StorageEngineP","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)"]}],"references":{"doc://Bodega/documentation/Bodega/StorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/StorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-9a3kk":{"defaultImplementations":1,"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"},"doc://Bodega/documentation/Bodega/StorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/removealldata()"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"},"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keycount()"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-1gzc6":{"defaultImplementations":1,"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/allKeys()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/allkeys()"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-90zkt":{"defaultImplementations":1,"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"},"doc://Bodega/documentation/Bodega/StorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-2lqqc":{"defaultImplementations":1,"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Actor","preciseIdentifier":"s:ScA"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is a construct you can build that plugs into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" "},{"type":"text","text":"to use for persisting data."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This library has two implementations of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Both of these can serve as inspiration if you have your own persistence mechanism (such as Realm, CoreData, etc)."}]},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and saves it to disk using file system operations."},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and saves it to an SQLite database under the hood."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you have your own way of storing data then you can refer to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" "},{"type":"text","text":"for inspiration, but all you need to do is conform to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol"},{"type":"text","text":" "},{"type":"text","text":"and initialize "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" with that storage."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"identifiers":["doc:\/\/Bodega\/s8SendableP","doc:\/\/Bodega\/ScA"],"kind":"relationships","title":"Inherits From","type":"inheritsFrom"},{"identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"],"kind":"relationships","title":"Conforming Types","type":"conformingTypes"}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"title":"StorageEngine","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:6Bodega13StorageEngineP","modules":[{"name":"Bodega"}],"navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/allKeys()","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)"]}],"references":{"doc://Bodega/documentation/Bodega/StorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/removealldata()"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/allKeys()":{"role":"symbol","title":"allKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"allKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/allKeys()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/allkeys()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keycount()"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readdataandkeys(keys:)"},"doc://Bodega/ScA":{"type":"unresolvable","title":"_Concurrency.Actor","identifier":"doc:\/\/Bodega\/ScA"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-90zkt":{"defaultImplementations":1,"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-9a3kk":{"defaultImplementations":1,"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-1gzc6":{"defaultImplementations":1,"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"},"doc://Bodega/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/Bodega\/s8SendableP"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-2lqqc":{"defaultImplementations":1,"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/createdat(key:).json b/docs/data/documentation/bodega/storageengine/createdat(key:).json index 1b7bb85..65f666f 100644 --- a/docs/data/documentation/bodega/storageengine/createdat(key:).json +++ b/docs/data/documentation/bodega/storageengine/createdat(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/createdat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"createdAt(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP9createdAt3key10Foundation4DateVSgAA8CacheKeyV_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/createdat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"createdAt(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP9createdAt3key10Foundation4DateVSgAA8CacheKeyV_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/createdAt(key:)":{"role":"symbol","title":"createdAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/createdAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/createdat(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/keycount().json b/docs/data/documentation/bodega/storageengine/keycount().json index 32baaa7..78ec499 100644 --- a/docs/data/documentation/bodega/storageengine/keycount().json +++ b/docs/data/documentation/bodega/storageengine/keycount().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"keyCount()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP8keyCountSiyYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keycount()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/keycount()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"keyCount()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP8keyCountSiyYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/keyCount()":{"role":"symbol","title":"keyCount()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyCount"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyCount()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keycount()"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/keyexists(_:).json b/docs/data/documentation/bodega/storageengine/keyexists(_:).json index bc51e51..d566a89 100644 --- a/docs/data/documentation/bodega/storageengine/keyexists(_:).json +++ b/docs/data/documentation/bodega/storageengine/keyexists(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/keyexists(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"keyExists(_:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP9keyExistsySbAA8CacheKeyVYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/keyexists(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"keyExists(_:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP9keyExistsySbAA8CacheKeyVYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/keyExists(_:)":{"role":"symbol","title":"keyExists(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyExists"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/keyExists(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/keyexists(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/read(key:).json b/docs/data/documentation/bodega/storageengine/read(key:).json index fa84998..8b49bd5 100644 --- a/docs/data/documentation/bodega/storageengine/read(key:).json +++ b/docs/data/documentation/bodega/storageengine/read(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/read(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP4read3key10Foundation4DataVSgAA8CacheKeyV_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/read(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP4read3key10Foundation4DataVSgAA8CacheKeyV_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/read(key:)":{"role":"symbol","title":"read(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/read(keys:)-1i8k4.json b/docs/data/documentation/bodega/storageengine/read(keys:)-1i8k4.json index 0ecf0da..e89737b 100644 --- a/docs/data/documentation/bodega/storageengine/read(keys:)-1i8k4.json +++ b/docs/data/documentation/bodega/storageengine/read(keys:)-1i8k4.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" stored on disk if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/read(keys:)-1i8k4"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tYaF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-1i8k4":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-1i8k4"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-90zkt":{"defaultImplementations":1,"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" stored on disk if the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s exist,"},{"type":"text","text":" "},{"type":"text","text":"and an "},{"type":"codeVoice","code":"[]"},{"type":"text","text":" if there is no "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" matching the "},{"type":"codeVoice","code":"keys"},{"type":"text","text":" passed in."}]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/read(keys:)-1i8k4"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tYaF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-90zkt":{"defaultImplementations":1,"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-1i8k4":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-1i8k4"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/read(keys:)-90zkt.json b/docs/data/documentation/bodega/storageengine/read(keys:)-90zkt.json index 5decb54..759b095 100644 --- a/docs/data/documentation/bodega/storageengine/read(keys:)-90zkt.json +++ b/docs/data/documentation/bodega/storageengine/read(keys:)-90zkt.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-1i8k4":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-1i8k4"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-90zkt":{"defaultImplementations":1,"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"read(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP4read4keysSay10Foundation4DataVGSayAA8CacheKeyVG_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-90zkt":{"defaultImplementations":1,"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-90zkt","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-90zkt"},"doc://Bodega/documentation/Bodega/StorageEngine/read(keys:)-1i8k4":{"role":"symbol","title":"read(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"read"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/read(keys:)-1i8k4","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/read(keys:)-1i8k4"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/readalldata()-1gzc6.json b/docs/data/documentation/bodega/storageengine/readalldata()-1gzc6.json index 468c4ed..eb1736e 100644 --- a/docs/data/documentation/bodega/storageengine/readalldata()-1gzc6.json +++ b/docs/data/documentation/bodega/storageengine/readalldata()-1gzc6.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllData()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP11readAllDataSay10Foundation0F0VGyYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-56p4o":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-56p4o"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-1gzc6":{"defaultImplementations":1,"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllData()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP11readAllDataSay10Foundation0F0VGyYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-1gzc6":{"defaultImplementations":1,"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-56p4o":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-56p4o"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/readalldata()-56p4o.json b/docs/data/documentation/bodega/storageengine/readalldata()-56p4o.json index 8307515..46487c0 100644 --- a/docs/data/documentation/bodega/storageengine/readalldata()-56p4o.json +++ b/docs/data/documentation/bodega/storageengine/readalldata()-56p4o.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" contained in a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldata()-56p4o"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllData()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE11readAllDataSay10Foundation0F0VGyYaF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-56p4o":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-56p4o"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-1gzc6":{"defaultImplementations":1,"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" contained in a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldata()-56p4o"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllData()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE11readAllDataSay10Foundation0F0VGyYaF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-1gzc6":{"defaultImplementations":1,"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-1gzc6","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-1gzc6"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllData()-56p4o":{"role":"symbol","title":"readAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllData()-56p4o","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldata()-56p4o"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/readalldataandkeys()-98wnz.json b/docs/data/documentation/bodega/storageengine/readalldataandkeys()-98wnz.json index 8f377ed..8dcce86 100644 --- a/docs/data/documentation/bodega/storageengine/readalldataandkeys()-98wnz.json +++ b/docs/data/documentation/bodega/storageengine/readalldataandkeys()-98wnz.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" and it’s associated "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s contained in a directory."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"codeVoice","code":"readAllData()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldataandkeys()-98wnz"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllDataAndKeys()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0F0V4datatGyYaF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-98wnz":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-98wnz"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-9a3kk":{"defaultImplementations":1,"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"An array of the "},{"type":"codeVoice","code":"[Data]"},{"type":"text","text":" and it’s associated "},{"type":"codeVoice","code":"CacheKey"},{"type":"text","text":"s contained in a directory."}]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This method returns the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" and "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" together in an array of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" "},{"type":"text","text":"allowing you to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a specific "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" item being retrieved."},{"type":"text","text":" "},{"type":"text","text":"This can be useful in allowing manual iteration over "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items, but if you don’t need"},{"type":"text","text":" "},{"type":"text","text":"to know which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" led to a piece of "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" being retrieved"},{"type":"text","text":" "},{"type":"text","text":"you can use "},{"type":"codeVoice","code":"readAllData()"},{"type":"text","text":" instead."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldataandkeys()-98wnz"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllDataAndKeys()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0F0V4datatGyYaF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-98wnz":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-98wnz"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-9a3kk":{"defaultImplementations":1,"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/readalldataandkeys()-9a3kk.json b/docs/data/documentation/bodega/storageengine/readalldataandkeys()-9a3kk.json index 2f490f2..502b7ef 100644 --- a/docs/data/documentation/bodega/storageengine/readalldataandkeys()-9a3kk.json +++ b/docs/data/documentation/bodega/storageengine/readalldataandkeys()-9a3kk.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllDataAndKeys()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0F0V4datatGyYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-9a3kk":{"defaultImplementations":1,"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-98wnz":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-98wnz"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"readAllDataAndKeys()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP18readAllDataAndKeysSayAA8CacheKeyV3key_10Foundation0F0V4datatGyYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-98wnz":{"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[{"type":"text","text":"Reads all the "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" located in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" and returns an array"},{"type":"text","text":" "},{"type":"text","text":"of "},{"type":"codeVoice","code":"[(CacheKey, Data)]"},{"type":"text","text":" tuples associated with the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-98wnz","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-98wnz"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/readAllDataAndKeys()-9a3kk":{"defaultImplementations":1,"role":"symbol","title":"readAllDataAndKeys()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readAllDataAndKeys"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readAllDataAndKeys()-9a3kk","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readalldataandkeys()-9a3kk"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/readdataandkeys(keys:).json b/docs/data/documentation/bodega/storageengine/readdataandkeys(keys:).json index d4196ca..a442fb7 100644 --- a/docs/data/documentation/bodega/storageengine/readdataandkeys(keys:).json +++ b/docs/data/documentation/bodega/storageengine/readdataandkeys(keys:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readdataandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"readDataAndKeys(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP15readDataAndKeys4keysSayAA8CacheKeyV3key_10Foundation0E0V4datatGSayAGG_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readdataandkeys(keys:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/readdataandkeys(keys:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"readDataAndKeys(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP15readDataAndKeys4keysSayAA8CacheKeyV3key_10Foundation0E0V4datatGSayAGG_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/readDataAndKeys(keys:)":{"role":"symbol","title":"readDataAndKeys(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"readDataAndKeys"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/readDataAndKeys(keys:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/readdataandkeys(keys:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/remove(key:).json b/docs/data/documentation/bodega/storageengine/remove(key:).json index 0cb638b..e870ef1 100644 --- a/docs/data/documentation/bodega/storageengine/remove(key:).json +++ b/docs/data/documentation/bodega/storageengine/remove(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/remove(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP6remove3keyyAA8CacheKeyV_tYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/remove(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP6remove3keyyAA8CacheKeyV_tYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/remove(key:)":{"role":"symbol","title":"remove(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(key:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/remove(keys:)-2lqqc.json b/docs/data/documentation/bodega/storageengine/remove(keys:)-2lqqc.json index 6d06aa0..3ea4598 100644 --- a/docs/data/documentation/bodega/storageengine/remove(keys:)-2lqqc.json +++ b/docs/data/documentation/bodega/storageengine/remove(keys:)-2lqqc.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP6remove4keysySayAA8CacheKeyVG_tYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-2lqqc":{"defaultImplementations":1,"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-fd9s":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-fd9s"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"StorageEngine Implementations","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s"]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP6remove4keysySayAA8CacheKeyVG_tYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-2lqqc":{"defaultImplementations":1,"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-fd9s":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-fd9s"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/remove(keys:)-fd9s.json b/docs/data/documentation/bodega/storageengine/remove(keys:)-fd9s.json index 64aa7bf..628613d 100644 --- a/docs/data/documentation/bodega/storageengine/remove(keys:)-fd9s.json +++ b/docs/data/documentation/bodega/storageengine/remove(keys:)-fd9s.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/remove(keys:)-fd9s"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE6remove4keysySayAA8CacheKeyVG_tYaKF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-fd9s":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-fd9s"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-2lqqc":{"defaultImplementations":1,"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"keys","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"codeVoice","code":"[CacheKey]"},{"type":"text","text":" for matching multiple "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items."}]}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/remove(keys:)-fd9s"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"kind":"symbol","metadata":{"role":"symbol","title":"remove(keys:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEnginePAAE6remove4keysySayAA8CacheKeyVG_tYaKF","extendedModule":"Bodega","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-2lqqc":{"defaultImplementations":1,"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-2lqqc","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-2lqqc"},"doc://Bodega/documentation/Bodega/StorageEngine/remove(keys:)-fd9s":{"role":"symbol","title":"remove(keys:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"remove"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Removes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" items based on the associated array of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":"s provided as a parameter."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/remove(keys:)-fd9s","kind":"symbol","type":"topic","url":"\/documentation\/bodega\/storageengine\/remove(keys:)-fd9s"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/removealldata().json b/docs/data/documentation/bodega/storageengine/removealldata().json index 3e83a83..5efffb7 100644 --- a/docs/data/documentation/bodega/storageengine/removealldata().json +++ b/docs/data/documentation/bodega/storageengine/removealldata().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/removealldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"removeAllData()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP13removeAllDatayyYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/removealldata()"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/removealldata()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"removeAllData()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP13removeAllDatayyYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/removeAllData()":{"role":"symbol","title":"removeAllData()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeAllData"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/removeAllData()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/removealldata()"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/updatedat(key:).json b/docs/data/documentation/bodega/storageengine/updatedat(key:).json index 45d8792..fa14200 100644 --- a/docs/data/documentation/bodega/storageengine/updatedat(key:).json +++ b/docs/data/documentation/bodega/storageengine/updatedat(key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/updatedat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"updatedAt(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP9updatedAt3key10Foundation4DateVSgAA8CacheKeyV_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/StorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/updatedat(key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"updatedAt(key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP9updatedAt3key10Foundation4DateVSgAA8CacheKeyV_tYaF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/updatedAt(key:)":{"role":"symbol","title":"updatedAt(key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/updatedAt(key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/updatedat(key:)"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/write(_:).json b/docs/data/documentation/bodega/storageengine/write(_:).json index cfd1170..a9509d8 100644 --- a/docs/data/documentation/bodega/storageengine/write(_:).json +++ b/docs/data/documentation/bodega/storageengine/write(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"dataAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/write(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"write(_:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP5writeyySayAA8CacheKeyV3key_10Foundation4DataV4datatGYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"dataAndKeys"},{"kind":"text","text":": [(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/write(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"write(_:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP5writeyySayAA8CacheKeyV3key_10Foundation4DataV4datatGYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/write(_:)":{"role":"symbol","title":"write(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"([(key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":", data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":")]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:)"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/storageengine/write(_:key:).json b/docs/data/documentation/bodega/storageengine/write(_:key:).json index 5e1392a..bd3a10d 100644 --- a/docs/data/documentation/bodega/storageengine/write(_:key:).json +++ b/docs/data/documentation/bodega/storageengine/write(_:key:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/write(_:key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"write(_:key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP5write_3keyy10Foundation4DataV_AA8CacheKeyVtYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/StorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:key:)"},"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV","text":"CacheKey"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/storageengine\/write(_:key:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"No overview available."}],"kind":"symbol","metadata":{"role":"symbol","title":"write(_:key:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"symbolKind":"method","externalID":"s:6Bodega13StorageEngineP5write_3keyy10Foundation4DataV_AA8CacheKeyVtYaKF","required":true,"modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega","doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"]]},"references":{"doc://Bodega/documentation/Bodega/CacheKey":{"role":"symbol","title":"CacheKey","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CacheKey"}],"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" is a type meant to provide a stable storage key."},{"type":"text","text":" "},{"type":"text","text":"If initialized from a URL the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey"},{"type":"text","text":" value will generate"},{"type":"text","text":" "},{"type":"text","text":"a consistent UUID-formatted MD5 version of the URL string as the key"},{"type":"text","text":" "},{"type":"text","text":"to ensure it is file system safe."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/CacheKey","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CacheKey"}],"url":"\/documentation\/bodega\/cachekey"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine/write(_:key:)":{"role":"symbol","title":"write(_:key:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"write"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CacheKey","preciseIdentifier":"s:6Bodega8CacheKeyV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine\/write(_:key:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/bodega\/storageengine\/write(_:key:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/using-objectstorage.json b/docs/data/documentation/bodega/using-objectstorage.json index ecbb805..4dbaa00 100644 --- a/docs/data/documentation/bodega/using-objectstorage.json +++ b/docs/data/documentation/bodega/using-objectstorage.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can learn about the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"},{"type":"text","text":", but at it’s most basic a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" defines functions such as "},{"type":"codeVoice","code":"read(key: CacheKey)"},{"type":"text","text":", "},{"type":"codeVoice","code":"write(data: Data, key: CacheKey)"},{"type":"text","text":", "},{"type":"codeVoice","code":"remove(key: CacheKey)"},{"type":"text","text":", to let you read, store, and delete "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from your data storage mechanism."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"As Swift developers we’re used to interacting with higher-level types rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":". Our apps include types such as "},{"type":"codeVoice","code":"String"},{"type":"text","text":", "},{"type":"codeVoice","code":"URL"},{"type":"text","text":", or custom models such as "},{"type":"codeVoice","code":"Note"},{"type":"text","text":" or "},{"type":"codeVoice","code":"Article"},{"type":"text","text":". "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" allows you to read, store, and delete Swift objects, that way you don’t have to think about the underlying data."}]},{"anchor":"Setting-Up-ObjectStorage","level":2,"type":"heading","text":"Setting Up ObjectStorage"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The relationship between "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is that an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is initialized with a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", but the API you’ll be interacting does not change no matter which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" you choose. This is very powerful because it gives us one API to work with no matter if we’re saving files to disk, reading objects from a database, or even downloading models from CloudKit. To achieve this we have only one requirement for our model, it must conform to "},{"type":"codeVoice","code":"Codable"},{"type":"text","text":". "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" requires "},{"type":"codeVoice","code":"Codable"},{"type":"text","text":" conformance so we can serialize items to their data storage, or even send them over the network."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ This could be any StorageEngine, so let's use the default SQLiteStorageEngine","let articlesStorageEngine = SQLiteStorageEngine.default(appendingPath: \"Articles\")","let articlesStorage = ObjectStorage(storage: articlesStorageEngine)","","\/\/ Or on one line","let articlesStorage = ObjectStorage
("," storage: SQLiteStorageEngine.default(appendingPath: \"Articles\")",")"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Now that "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is setup, using it couldn’t be simpler. The API is very similar to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" API, but with slight function name differences to make the API feel more natural when working with Swift types rather than raw "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]},{"type":"codeListing","syntax":"swift","code":["let article = Article(title: \"How To Learn Swift\", text: \"... and then you practice for years\")","","\/\/ Write an article to your ObjectStorage","try await articlesStorage.store(article, forKey: CacheKey(\"how-to-learn-swift\"))","","\/\/ Read the article from your ObjectStorage","try await storage.object(forKey: CacheKey(\"how-to-learn-swift\"))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"And that’s it! You now have a data storage layer that can work with your app’s Swift types in only a few lines of code."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/using-objectstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","interfaceLanguage":"swift"},"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Using ObjectStorage","role":"article","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"seeAlsoSections":[{"title":"Fundamentals","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"],"generated":true}],"references":{"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/Using-StorageEngines":{"role":"article","title":"Using StorageEngines","abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-storageengines"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can learn about the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"},{"type":"text","text":", but at it’s most basic a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" defines functions such as "},{"type":"codeVoice","code":"read(key: CacheKey)"},{"type":"text","text":", "},{"type":"codeVoice","code":"write(data: Data, key: CacheKey)"},{"type":"text","text":", "},{"type":"codeVoice","code":"remove(key: CacheKey)"},{"type":"text","text":", to let you read, store, and delete "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" from your data storage mechanism."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"As Swift developers we’re used to interacting with higher-level types rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":". Our apps include types such as "},{"type":"codeVoice","code":"String"},{"type":"text","text":", "},{"type":"codeVoice","code":"URL"},{"type":"text","text":", or custom models such as "},{"type":"codeVoice","code":"Note"},{"type":"text","text":" or "},{"type":"codeVoice","code":"Article"},{"type":"text","text":". "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" allows you to read, store, and delete Swift objects, that way you don’t have to think about the underlying data."}]},{"anchor":"Setting-Up-ObjectStorage","level":2,"type":"heading","text":"Setting Up ObjectStorage"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The relationship between "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is that an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is initialized with a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", but the API you’ll be interacting does not change no matter which "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" you choose. This is very powerful because it gives us one API to work with no matter if we’re saving files to disk, reading objects from a database, or even downloading models from CloudKit. To achieve this we have only one requirement for our model, it must conform to "},{"type":"codeVoice","code":"Codable"},{"type":"text","text":". "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" requires "},{"type":"codeVoice","code":"Codable"},{"type":"text","text":" conformance so we can serialize items to their data storage, or even send them over the network."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ This could be any StorageEngine, so let's use the default SQLiteStorageEngine","let articlesStorageEngine = SQLiteStorageEngine.default(appendingPath: \"Articles\")","let articlesStorage = ObjectStorage(storage: articlesStorageEngine)","","\/\/ Or on one line","let articlesStorage = ObjectStorage
("," storage: SQLiteStorageEngine.default(appendingPath: \"Articles\")",")"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Now that "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" is setup, using it couldn’t be simpler. The API is very similar to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" API, but with slight function name differences to make the API feel more natural when working with Swift types rather than raw "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}]},{"type":"codeListing","syntax":"swift","code":["let article = Article(title: \"How To Learn Swift\", text: \"... and then you practice for years\")","","\/\/ Write an article to your ObjectStorage","try await articlesStorage.store(article, forKey: CacheKey(\"how-to-learn-swift\"))","","\/\/ Read the article from your ObjectStorage","try await storage.object(forKey: CacheKey(\"how-to-learn-swift\"))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"And that’s it! You now have a data storage layer that can work with your app’s Swift types in only a few lines of code."}]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/using-objectstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","interfaceLanguage":"swift"},"abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Using ObjectStorage","role":"article","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"seeAlsoSections":[{"title":"Fundamentals","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines"],"generated":true}],"references":{"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"doc://Bodega/documentation/Bodega/Using-StorageEngines":{"role":"article","title":"Using StorageEngines","abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-storageengines"},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"}}} \ No newline at end of file diff --git a/docs/data/documentation/bodega/using-storageengines.json b/docs/data/documentation/bodega/using-storageengines.json index 07838f3..ffbf613 100644 --- a/docs/data/documentation/bodega/using-storageengines.json +++ b/docs/data/documentation/bodega/using-storageengines.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for persisting data. A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is a construct you can build to store "},{"type":"codeVoice","code":"Data"},{"type":"text","text":", or you can plug it into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to have a unified type-safe Swift API to use for persisting data. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" provides a higher-level abstraction so you don’t ever have to think about databases, persistence layers, or servers."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This library has two implementations of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":", both of which we’ll discuss below. Each can serve as inspiration if you want to build a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" for your own persistence mechanism such as Realm, CoreData, CloudKit, etc."}]},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and saves it to disk using file system operations. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and transparently saves it to an SQLite database. This is fundamentally how a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" works, the protocol provides a blueprint for how to map Swift values and objects to "},{"type":"codeVoice","code":"Data"},{"type":"text","text":", and how to map "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" back to Swift types."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If your app already has a persistence layer then you can create a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" by conforming to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", such as creating a "},{"type":"codeVoice","code":"CoreDataStorageEngine"},{"type":"text","text":", "},{"type":"codeVoice","code":"RealmStorageEngine"},{"type":"text","text":", or even "},{"type":"codeVoice","code":"CloudKitStorageEngine"},{"type":"text","text":" to handle the needs of your app. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" both serve as good references for building your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"For now let’s discuss Bodega’s built-in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" options."}]},{"anchor":"Which-StorageEngine-Is-Right-For-You?","level":2,"type":"heading","text":"Which StorageEngine Is Right For You?"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The answer will almost always be "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":". The reason why is simple, it’s significantly faster than "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". If your app is storing more than a few thousand objects then a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":"-backed "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" will end up having long initialization times. But if you’re not worried about performance and would prefer the ability to inspect the underlying data without an SQLite editor, then using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" is a reasonable choice."}]},{"anchor":"DiskStorageEngine","level":2,"type":"heading","text":"DiskStorageEngine"},{"type":"paragraph","inlineContent":[{"type":"text","text":"In Bodega v1 there was no concept of a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", everyone was implicitly using a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". In v2 we created the new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" abstraction, and rebuilt "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" by conforming to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"To initialize a "},{"type":"codeVoice","code":"DiskStorageEngine"},{"type":"text","text":" all you need to do is write one line of code."}]},{"type":"codeListing","syntax":"swift","code":["private let imagesStorage = DiskStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Images\"))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"As with any other "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" you’ll then be able to read or write data to and from the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":"."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Write data to disk","try await self.imagesStorage.write(data, key: CacheKey(\"red-panda.jpg\"))","","\/\/ Read data from disk","await self.imagesStorage.read(key: CacheKey(\"red-panda.jpg\"))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" prioritizes simplicity over speed, focusing on ease of use and debugging. The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" will write a one file for every object you save to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". That makes it easy to inspect and debug any objects you’re saving, with a downside of poor performance as your "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" grows."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Initialization times vary based on the total number of objects you have saved, but a rule of thumb is that loading 1,000 objects from disk takes about 0.25 seconds. This can start to feel a bit slow if you are saving more than 2,000-3,000 objects, at which point"},{"type":"text","text":" "},{"type":"text","text":"it may be worth investigating an alternative "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". By comparison if you’re using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" it only takes about 0.1 seconds to load 1,000 objects, the difference only growing more the more objects you have. Since "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" is backed by files, every operating system write or remove operation carries additional overhead, saving 10 files to disk requires 10 separate writes."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This is different than an alternative like "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" where you only have one database that you write to and read from. This may not sound like a big difference but when you look at how it scales you can see that "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is a superior choice for larger apps."}]},{"type":"paragraph","inlineContent":[{"type":"image","identifier":"StorageEngine-Read-Performance"},{"type":"text","text":" "},{"type":"image","identifier":"StorageEngine-Write-Performance"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If performance is important "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega"},{"type":"text","text":" ships "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":", and that is the recommended"},{"type":"text","text":" "},{"type":"text","text":"default "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If you have your own persistence layer such as Core Data, Realm, etc,"},{"type":"text","text":" "},{"type":"text","text":"you can choose to build your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" to plug into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":"."}]},{"anchor":"SQLiteStorageEngine","level":2,"type":"heading","text":"SQLiteStorageEngine"},{"type":"paragraph","inlineContent":[{"type":"text","text":"As the name implies, "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is Bodega’s default "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", If you’re not using your own persistence mechanism such as Core Data, Realm, etc, it is highly recommended you use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" to power your "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" (or Store if you’re using "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/mergesort\/Boutique"},{"type":"text","text":")."}]},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is the default because it is significantly faster than "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". As much as "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" was optimized, file system operations like writing and removing files have a relatively high cost per operation. SQLite on the other hand "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html"},{"type":"text","text":" to be significantly faster than files for storing data."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The simplest way to get started with "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is to use one of the defaults."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Initializes an SQLiteStorageEngine in the platform-specific default storage directory","let storage = SQLiteStorageEngine.default","","\/\/ Initializes an SQLiteStorageEngine in the platform-specific default storage directory, appending the path \"Animals\"","let animalsStorage = SQLiteStorageEngine.default(appendingPath: \"Animals\")"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you require more flexibility in specifying where you’d like to save your data you can use the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" initializer with a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" parameter."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Equivalent to SQLiteStorageEngine.default(appendingPath: \"Animals\")","let animalsStorage = SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Animals\"))","","\/\/ Initializes an SQLiteStorageEngine in the caches directory, appending the path \"Animals\"","let animalsStorage = SQLiteStorageEngine(directory: .caches(appendingPath: \"Animals\"))"]},{"anchor":"FileManager.Directory","level":2,"type":"heading","text":"FileManager.Directory"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Above we setup an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" pointing to the "},{"type":"codeVoice","code":".caches"},{"type":"text","text":" directory. This is thanks to a few static functions on "},{"type":"codeVoice","code":"FileManager.Directory"},{"type":"text","text":" that handle the locations most iOS and macOS apps store data."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Works only on macOS","static func applicationSupport(appendingPath pathComponent: String) -> FileManager.Directory","","static func caches(appendingPath pathComponent: String) -> FileManager.Directory","","static func documents(appendingPath pathComponent: String) -> FileManager.Directory","","\/\/ For apps that use Apple's App Groups feature to share data between multiple apps and extensions.","static func sharedContainer(forAppGroupIdentifier identifier: String, appendingPath pathComponent: String) -> FileManager.Directory","","static func temporary(appendingPath pathComponent: String) -> FileManager.Directory"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Depending on the needs of your app you can choose where to create the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" or "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":". Otherwise the default location will choose the "},{"type":"codeVoice","code":"Documents"},{"type":"text","text":" folder on all platforms other than macOS, where the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" will default to "},{"type":"codeVoice","code":"Application Support"},{"type":"text","text":", matching platform conventions."}]},{"type":"codeListing","syntax":"swift","code":["static func defaultStorageDirectory(appendingPath pathComponent: String) -> FileManager.Directory"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/using-storageengines"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Using StorageEngines","role":"article","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"seeAlsoSections":[{"title":"Fundamentals","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"],"generated":true}],"references":{"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"doc://Bodega/documentation/Bodega/Using-ObjectStorage":{"role":"article","title":"Using ObjectStorage","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-objectstorage"},"https://github.com/mergesort/Boutique":{"title":"Boutique","titleInlineContent":[{"type":"text","text":"Boutique"}],"type":"link","identifier":"https:\/\/github.com\/mergesort\/Boutique","url":"https:\/\/github.com\/mergesort\/Boutique"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"StorageEngine-Read-Performance":{"alt":"StorageEngine Read Performance","type":"image","identifier":"StorageEngine-Read-Performance","variants":[{"url":"\/images\/StorageEngine-Read-Performance.png","traits":["1x","light"]}]},"StorageEngine-Write-Performance":{"alt":"StorageEngine Write Performance","type":"image","identifier":"StorageEngine-Write-Performance","variants":[{"url":"\/images\/StorageEngine-Write-Performance.png","traits":["1x","light"]}]},"https://www.sqlite.org/fasterthanfs.html":{"title":"has been shown","titleInlineContent":[{"type":"text","text":"has been shown"}],"type":"link","identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html","url":"https:\/\/www.sqlite.org\/fasterthanfs.html"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for persisting data. A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is a construct you can build to store "},{"type":"codeVoice","code":"Data"},{"type":"text","text":", or you can plug it into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" to have a unified type-safe Swift API to use for persisting data. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" provides a higher-level abstraction so you don’t ever have to think about databases, persistence layers, or servers."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This library has two implementations of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":", both of which we’ll discuss below. Each can serve as inspiration if you want to build a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" for your own persistence mechanism such as Realm, CoreData, CloudKit, etc."}]},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and saves it to disk using file system operations. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" takes "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" and transparently saves it to an SQLite database. This is fundamentally how a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" works, the protocol provides a blueprint for how to map Swift values and objects to "},{"type":"codeVoice","code":"Data"},{"type":"text","text":", and how to map "},{"type":"codeVoice","code":"Data"},{"type":"text","text":" back to Swift types."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If your app already has a persistence layer then you can create a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" by conforming to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", such as creating a "},{"type":"codeVoice","code":"CoreDataStorageEngine"},{"type":"text","text":", "},{"type":"codeVoice","code":"RealmStorageEngine"},{"type":"text","text":", or even "},{"type":"codeVoice","code":"CloudKitStorageEngine"},{"type":"text","text":" to handle the needs of your app. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" both serve as good references for building your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"For now let’s discuss Bodega’s built-in "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" options."}]},{"anchor":"Which-StorageEngine-Is-Right-For-You?","level":2,"type":"heading","text":"Which StorageEngine Is Right For You?"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The answer will almost always be "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":". The reason why is simple, it’s significantly faster than "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". If your app is storing more than a few thousand objects then a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":"-backed "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" will end up having long initialization times. But if you’re not worried about performance and would prefer the ability to inspect the underlying data without an SQLite editor, then using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" is a reasonable choice."}]},{"anchor":"DiskStorageEngine","level":2,"type":"heading","text":"DiskStorageEngine"},{"type":"paragraph","inlineContent":[{"type":"text","text":"In Bodega v1 there was no concept of a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", everyone was implicitly using a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". In v2 we created the new "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" abstraction, and rebuilt "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" by conforming to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" protocol."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"To initialize a "},{"type":"codeVoice","code":"DiskStorageEngine"},{"type":"text","text":" all you need to do is write one line of code."}]},{"type":"codeListing","syntax":"swift","code":["private let imagesStorage = DiskStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Images\"))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"As with any other "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" you’ll then be able to read or write data to and from the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":"."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Write data to disk","try await self.imagesStorage.write(data, key: CacheKey(\"red-panda.jpg\"))","","\/\/ Read data from disk","await self.imagesStorage.read(key: CacheKey(\"red-panda.jpg\"))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" prioritizes simplicity over speed, focusing on ease of use and debugging. The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" will write a one file for every object you save to the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". That makes it easy to inspect and debug any objects you’re saving, with a downside of poor performance as your "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" grows."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Initialization times vary based on the total number of objects you have saved, but a rule of thumb is that loading 1,000 objects from disk takes about 0.25 seconds. This can start to feel a bit slow if you are saving more than 2,000-3,000 objects, at which point"},{"type":"text","text":" "},{"type":"text","text":"it may be worth investigating an alternative "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". By comparison if you’re using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" it only takes about 0.1 seconds to load 1,000 objects, the difference only growing more the more objects you have. Since "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" is backed by files, every operating system write or remove operation carries additional overhead, saving 10 files to disk requires 10 separate writes."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This is different than an alternative like "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" where you only have one database that you write to and read from. This may not sound like a big difference but when you look at how it scales you can see that "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is a superior choice for larger apps."}]},{"type":"paragraph","inlineContent":[{"type":"image","identifier":"StorageEngine-Read-Performance"},{"type":"text","text":" "},{"type":"image","identifier":"StorageEngine-Write-Performance"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If performance is important "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega"},{"type":"text","text":" ships "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":", and that is the recommended"},{"type":"text","text":" "},{"type":"text","text":"default "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":". If you have your own persistence layer such as Core Data, Realm, etc,"},{"type":"text","text":" "},{"type":"text","text":"you can choose to build your own "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" to plug into "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":"."}]},{"anchor":"SQLiteStorageEngine","level":2,"type":"heading","text":"SQLiteStorageEngine"},{"type":"paragraph","inlineContent":[{"type":"text","text":"As the name implies, "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database. "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is Bodega’s default "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", If you’re not using your own persistence mechanism such as Core Data, Realm, etc, it is highly recommended you use "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" to power your "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" (or Store if you’re using "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/mergesort\/Boutique"},{"type":"text","text":")."}]},{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is the default because it is significantly faster than "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":". As much as "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" was optimized, file system operations like writing and removing files have a relatively high cost per operation. SQLite on the other hand "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html"},{"type":"text","text":" to be significantly faster than files for storing data."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The simplest way to get started with "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" is to use one of the defaults."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Initializes an SQLiteStorageEngine in the platform-specific default storage directory","let storage = SQLiteStorageEngine.default","","\/\/ Initializes an SQLiteStorageEngine in the platform-specific default storage directory, appending the path \"Animals\"","let animalsStorage = SQLiteStorageEngine.default(appendingPath: \"Animals\")"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you require more flexibility in specifying where you’d like to save your data you can use the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" initializer with a "},{"type":"codeVoice","code":"directory"},{"type":"text","text":" parameter."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Equivalent to SQLiteStorageEngine.default(appendingPath: \"Animals\")","let animalsStorage = SQLiteStorageEngine(directory: .defaultStorageDirectory(appendingPath: \"Animals\"))","","\/\/ Initializes an SQLiteStorageEngine in the caches directory, appending the path \"Animals\"","let animalsStorage = SQLiteStorageEngine(directory: .caches(appendingPath: \"Animals\"))"]},{"anchor":"FileManager.Directory","level":2,"type":"heading","text":"FileManager.Directory"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Above we setup an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":" pointing to the "},{"type":"codeVoice","code":".caches"},{"type":"text","text":" directory. This is thanks to a few static functions on "},{"type":"codeVoice","code":"FileManager.Directory"},{"type":"text","text":" that handle the locations most iOS and macOS apps store data."}]},{"type":"codeListing","syntax":"swift","code":["\/\/ Works only on macOS","static func applicationSupport(appendingPath pathComponent: String) -> FileManager.Directory","","static func caches(appendingPath pathComponent: String) -> FileManager.Directory","","static func documents(appendingPath pathComponent: String) -> FileManager.Directory","","\/\/ For apps that use Apple's App Groups feature to share data between multiple apps and extensions.","static func sharedContainer(forAppGroupIdentifier identifier: String, appendingPath pathComponent: String) -> FileManager.Directory","","static func temporary(appendingPath pathComponent: String) -> FileManager.Directory"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Depending on the needs of your app you can choose where to create the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine"},{"type":"text","text":" or "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine"},{"type":"text","text":". Otherwise the default location will choose the "},{"type":"codeVoice","code":"Documents"},{"type":"text","text":" folder on all platforms other than macOS, where the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" will default to "},{"type":"codeVoice","code":"Application Support"},{"type":"text","text":", matching platform conventions."}]},{"type":"codeListing","syntax":"swift","code":["static func defaultStorageDirectory(appendingPath pathComponent: String) -> FileManager.Directory"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/bodega\/using-storageengines"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Bodega\/documentation\/Bodega\/Using-StorageEngines","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" is at the heart of what makes Bodega, Bodega."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Using StorageEngines","role":"article","modules":[{"name":"Bodega"}]},"hierarchy":{"paths":[["doc:\/\/Bodega\/documentation\/Bodega"]]},"seeAlsoSections":[{"title":"Fundamentals","identifiers":["doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage"],"generated":true}],"references":{"StorageEngine-Read-Performance":{"alt":"StorageEngine Read Performance","type":"image","identifier":"StorageEngine-Read-Performance","variants":[{"url":"\/images\/StorageEngine-Read-Performance.png","traits":["1x","light"]}]},"doc://Bodega/documentation/Bodega/ObjectStorage":{"role":"symbol","title":"ObjectStorage","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"ObjectStorage"}],"abstract":[{"type":"text","text":"A unified layer over a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" primitives, allowing you to read, write, and save Swift objects."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ObjectStorage"}],"url":"\/documentation\/bodega\/objectstorage"},"https://github.com/mergesort/Boutique":{"title":"Boutique","titleInlineContent":[{"type":"text","text":"Boutique"}],"type":"link","identifier":"https:\/\/github.com\/mergesort\/Boutique","url":"https:\/\/github.com\/mergesort\/Boutique"},"doc://Bodega/documentation/Bodega/DiskStorageEngine":{"role":"symbol","title":"DiskStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"DiskStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on saving items to the file system."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/DiskStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DiskStorageEngine"}],"url":"\/documentation\/bodega\/diskstorageengine"},"doc://Bodega/documentation/Bodega/StorageEngine":{"role":"symbol","title":"StorageEngine","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"StorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" represents a data storage mechanism for saving and persisting data."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StorageEngine"}],"url":"\/documentation\/bodega\/storageengine"},"https://www.sqlite.org/fasterthanfs.html":{"title":"has been shown","titleInlineContent":[{"type":"text","text":"has been shown"}],"type":"link","identifier":"https:\/\/www.sqlite.org\/fasterthanfs.html","url":"https:\/\/www.sqlite.org\/fasterthanfs.html"},"doc://Bodega/documentation/Bodega":{"role":"collection","title":"Bodega","abstract":[{"type":"text","text":"A simple store all your basic needs, and also so much more. 🐱"}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega","kind":"symbol","type":"topic","url":"\/documentation\/bodega"},"doc://Bodega/documentation/Bodega/SQLiteStorageEngine":{"role":"symbol","title":"SQLiteStorageEngine","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"SQLiteStorageEngine"}],"abstract":[{"type":"text","text":"A "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":" based on an SQLite database."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/SQLiteStorageEngine","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SQLiteStorageEngine"}],"url":"\/documentation\/bodega\/sqlitestorageengine"},"StorageEngine-Write-Performance":{"alt":"StorageEngine Write Performance","type":"image","identifier":"StorageEngine-Write-Performance","variants":[{"url":"\/images\/StorageEngine-Write-Performance.png","traits":["1x","light"]}]},"doc://Bodega/documentation/Bodega/Using-ObjectStorage":{"role":"article","title":"Using ObjectStorage","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/ObjectStorage"},{"type":"text","text":" serves as unified layer over "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/StorageEngine"},{"type":"text","text":", allowing you to work with type-safe Swift models rather than "},{"type":"codeVoice","code":"Data"},{"type":"text","text":"."}],"identifier":"doc:\/\/Bodega\/documentation\/Bodega\/Using-ObjectStorage","kind":"article","type":"topic","url":"\/documentation\/bodega\/using-objectstorage"}}} \ No newline at end of file