storage.hpp File Reference

Storage operations for the oxy API. More...

Classes
struct	oxy::api::export_contents_fn
	Function object to export contents from a storage container to a file in the oxy API. More...
struct	oxy::api::get_commit_fn
	Function object to retrieve a commit from the storage container in the OXY-API. More...
struct	oxy::api::get_contents_fn
	Function object to retrieve contents from a storage container in the OXY-API. More...
struct	oxy::api::get_entry_fn
	Function object to retrieve an entry from the storage container in the OXY-API. More...
struct	oxy::api::get_index_fn
	Function object to retrieve the index from a storage container in the OXY-API. More...
struct	oxy::api::get_references_fn
	Function object to retrieve references from a storage container in the OXY-API. More...
struct	oxy::api::import_contents_fn
	Function object to import contents from a file into a storage container in the OXY-API. More...
struct	oxy::api::IStorage
	Interface for storage operations in the OXY-API. More...
struct	oxy::api::make_commit_fn
	Function object to create a commit in the storage container in the OXY-API. More...
struct	oxy::api::make_entry_fn
	Function object to create an entry in the storage container in the OXY-API. More...
struct	oxy::api::open_storage_fn
	Function object to open a storage container connection in the OXY-API. More...
struct	oxy::api::remove_entry_fn
	Function object to remove an entry from the storage container in the OXY-API. More...
struct	oxy::api::set_contents_fn
	Function object to set contents in a storage container in the OXY-API. More...
struct	oxy::api::set_entry_fn
	Function object to set an entry in the storage container in the OXY-API. More...

Namespaces
namespace	oxy
	This root namespace contains the common types and operations for the OXY-API library.
namespace	oxy::api
	This namespace contains the high-level definitions and operations for the OXY-API library.

Typedefs
using	oxy::api::IStoragePtr = std::shared_ptr<IStorage>
using	oxy::api::references = std::map<std::string, std::string>

Variables
constexpr make_commit_fn	oxy::api::commit
	A constexpr instance of the make_commit_fn function object for use in functional programming.
constexpr export_contents_fn	oxy::api::export_contents
	A constexpr instance of the export_contents_fn function object for use in functional programming.
constexpr get_commit_fn	oxy::api::get_commit
	A constexpr instance of the get_commit_fn function object for use in functional programming.
constexpr get_contents_fn	oxy::api::get_contents
	A constexpr instance of the get_contents_fn function object for use in functional programming.
constexpr get_entry_fn	oxy::api::get_entry
	A constexpr instance of the get_entry_fn function object for use in functional programming.
constexpr get_index_fn	oxy::api::get_index
	A constexpr instance of the get_index_fn function object for use in functional programming.
constexpr get_references_fn	oxy::api::get_references
	A constexpr instance of the get_references_fn function object for use in functional programming.
constexpr import_contents_fn	oxy::api::import_contents
	A constexpr instance of the import_contents_fn function object for use in functional programming.
constexpr make_entry_fn	oxy::api::make_entry
	A constexpr instance of the make_entry_fn function object for use in functional programming.
constexpr open_storage_fn	oxy::api::open_storage
	A constexpr instance of the open_storage_fn function object for use in functional programming.
constexpr remove_entry_fn	oxy::api::remove_entry
	A constexpr instance of the remove_entry_fn function object for use in functional programming.
constexpr set_contents_fn	oxy::api::set_contents
	A constexpr instance of the set_contents_fn function object for use in functional programming.
constexpr set_entry_fn	oxy::api::set_entry
	A constexpr instance of the set_entry_fn function object for use in functional programming.

Detailed Description

Storage operations for the oxy API.

This header defines the IStorage interface and related function objects for storage operations in the oxy API. It provides methods for opening storage connections, retrieving and setting contents, and exporting/importing contents to/from files. The operations are designed to be used in a constexpr context for compile-time evaluation of storage operations.

@license MPL-2.0