This namespace contains the high-level definitions and operations for the OXY-API library. More...

Namespaces
namespace	container
	This namespace contains function objects and operations related to container storage management in the OXY-API.
namespace	metadata
	This namespace contains function objects and operations related to container metadata management in the metadata database.
namespace	settings
	This namespace contains function objects and operations related to application settings.

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

Typedefs
using	category_link_t = oxy::category_link_t
using	category_t = oxy::category_t
using	IStoragePtr = std::shared_ptr<IStorage>
using	references = std::map<std::string, std::string>
using	tag_link_t = oxy::tag_link_t
using	tag_t = oxy::tag_t
using	tags_t = oxy::tags_t

Functions
void	tag_invoke (boost::json::value_from_tag, boost::json::value &jv, manifest_t const &item)
	Converts a manifest object to a Boost.JSON value using tag_invoke customization point.
void	tag_invoke (boost::json::value_from_tag, boost::json::value &jv, stream_t const &item)
	Converts a stream object to a Boost.JSON value using tag_invoke customization point.
manifest_t	tag_invoke (const boost::json::value_to_tag< manifest_t > &, boost::json::value const &jv)
	Converts a Boost.JSON value to a manifest_t object using tag_invoke customization point.
stream_t	tag_invoke (const boost::json::value_to_tag< stream_t > &, boost::json::value const &jv)
	Converts a Boost.JSON value to a stream_t object using tag_invoke customization point.

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

Detailed Description

This namespace contains the high-level definitions and operations for the OXY-API library.

The oxy::api namespace provides the core abstractions and interfaces for interacting with the OXY-API library, including storage operations, metadata management, and type definitions. It serves as the primary entry point for developers using the OXY-API library to build applications that leverage the functionality provided by the library.

Function Documentation

◆ tag_invoke() [1/4]

void oxy::api::tag_invoke	(	boost::json::value_from_tag	,
		boost::json::value &	jv,
		manifest_t const &	item )

inline

Converts a manifest object to a Boost.JSON value using tag_invoke customization point.

Parameters

Tag	type used for tag_invoke dispatch (unnamed parameter).
jv	The JSON value object to populate with the manifest data.
item	The manifest object to convert to JSON.

References oxy::set_value.

◆ tag_invoke() [2/4]

void oxy::api::tag_invoke	(	boost::json::value_from_tag	,
		boost::json::value &	jv,
		stream_t const &	item )

inline

Converts a stream object to a Boost.JSON value using tag_invoke customization point.

Parameters

Tag	type used for tag_invoke dispatch (unnamed parameter).
jv	The JSON value object to populate with the stream data.
item	The stream object to convert to JSON.

References oxy::set_value.

◆ tag_invoke() [3/4]

manifest_t oxy::api::tag_invoke	(	const boost::json::value_to_tag< manifest_t > &	,
		boost::json::value const &	jv )

inline

Converts a Boost.JSON value to a manifest_t object using tag_invoke customization point.

Parameters

Tag	type used for tag_invoke dispatch to specify conversion to manifest_t.
jv	The JSON value to convert from.

Returns: A manifest_t object constructed from the JSON value's fields: name (required), category (optional, defaults to empty), and tags (optional, defaults to empty).

References oxy::get_value().

◆ tag_invoke() [4/4]

stream_t oxy::api::tag_invoke	(	const boost::json::value_to_tag< stream_t > &	,
		boost::json::value const &	jv )

inline

Converts a Boost.JSON value to a stream_t object using tag_invoke customization point.

Parameters

Tag	type used for tag_invoke dispatch to specify conversion to stream_t.
jv	The JSON value to convert from.

Returns: A stream_t object constructed from the JSON value's fields: name (required), mime (optional, defaults to empty), and tags (optional, defaults to empty).

References oxy::get_value().

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Function Documentation

◆ tag_invoke() [1/4]

◆ tag_invoke() [2/4]

◆ tag_invoke() [3/4]

◆ tag_invoke() [4/4]