|
OXY API 1.0
OXY API Library Documentation
|
| Noxy | This root namespace contains the common types and operations for the OXY-API library |
| Napi | This namespace contains the high-level definitions and operations for the OXY-API library |
| Ncontainer | This namespace contains function objects and operations related to container storage management in the OXY-API |
| Cfrom_record_fn | Function object to convert a record to a manifest |
| Cget_manifest_fn | Function object to retrieve the manifest from a container storage |
| Cget_metadata_fn | Function object to retrieve metadata from a container storage |
| Cget_path_fn | Function object to retrieve the filesystem path associated with a given OID |
| Cget_record_fn | Function object to retrieve a record from a container storage |
| Cset_manifest_fn | Function object to set the manifest in a container storage |
| Cset_metadata_fn | Function object to set metadata in a container storage |
| Cto_record_fn | Function object to convert a manifest and container OID to a record |
| Nmetadata | This namespace contains function objects and operations related to container metadata management in the metadata database |
| Ncategory | This namespace contains function objects and operations related to categories in the metadata database |
| Ccount_fn | Function object to count categories in the metadata database based on a where clause |
| Cprepare_fn | Function object to prepare the category management in the metadata database |
| Cpull_fn | Function object to pull the categories from the metadata database |
| Cpush_fn | Function object to push categories to the metadata database |
| Cpush_link_fn | Function object to push category links to the metadata database |
| Cremove_all_fn | Function object to remove all categories from the metadata database |
| Cremove_fn | Function object to remove categories from the metadata database |
| Cselect_fn | Function object to select categories from the metadata database based on a where clause |
| Ntag | This namespace contains function objects and operations related to tags in the metadata database |
| Ccount_fn | Function object to count tags in the metadata database based on a where clause |
| Cprepare_fn | Function object to prepare the tag management in the metadata database |
| Cpull_fn | Function object to pull the tags from the metadata database |
| Cpush_fn | Function object to push the tags to the metadata database |
| Cpush_link_fn | Function object to push tag links to the metadata database |
| Cremove_all_fn | Function object to remove all tags from the metadata database |
| Cremove_fn | Function object to remove tags from the metadata database |
| Cselect_fn | Function object to select tags from the metadata database based on a where clause |
| Ccopy_fn | Function object to copy metadata from one context to another |
| Ccount_fn | Function object to count the number of records in the container metadata database |
| Cgen_where_fn | Function object to generate a WHERE clause from an expression |
| Cget_context_fn | Function object to retrieve a context for container metadata record operations in the metadata database |
| Cget_fn | Function object to retrieve a container metadata record and its timestamp from the metadata database |
| Cmerge_fn | Function object to merge metadata from one context into another |
| Cpull_fn | Function object to pull container metadata records and their timestamps from the metadata database |
| Cpush_fn | Function object to push records into the container metadata database |
| Cpush_time_stamped_fn | Function object to push records with timestamps into the container metadata database |
| Cremove_all_fn | Function object to remove all records from the container metadata database |
| Cremove_fn | Function object to remove records from the container metadata database |
| Cselect_fn | Function object to select OIDs from the container metadata database based on an expression |
| Nsettings | This namespace contains function objects and operations related to application settings |
| Cconfig_path_t | Represents the default configuration file path for the application |
| Cexpand_fn | Function object to expand environment variables in settings paths |
| Cget_fn | Function object to retrieve the application settings |
| Cload_fn | Function object to load settings from an INI configuration file |
| Cremove_quote_fn | Function object to remove quotes from a string |
| Csettings_t | Represents the configuration settings for the application |
| Cexport_contents_fn | Function object to export contents from a storage container to a file in the oxy API |
| Cget_commit_fn | Function object to retrieve a commit from the storage container in the OXY-API |
| Cget_contents_fn | Function object to retrieve contents from a storage container in the OXY-API |
| Cget_entry_fn | Function object to retrieve an entry from the storage container in the OXY-API |
| Cget_index_fn | Function object to retrieve the index from a storage container in the OXY-API |
| Cget_references_fn | Function object to retrieve references from a storage container in the OXY-API |
| Cimport_contents_fn | Function object to import contents from a file into a storage container in the OXY-API |
| CIStorage | Interface for storage operations in the OXY-API |
| Cmake_commit_fn | Function object to create a commit in the storage container in the OXY-API |
| Cmake_entry_fn | Function object to create an entry in the storage container in the OXY-API |
| Cmanifest_t | In-memory representation of a manifest |
| Copen_storage_fn | Function object to open a storage container connection in the OXY-API |
| Cremove_entry_fn | Function object to remove an entry from the storage container in the OXY-API |
| Cset_contents_fn | Function object to set contents in a storage container in the OXY-API |
| Cset_entry_fn | Function object to set an entry in the storage container in the OXY-API |
| Cstream_t | In-memory representation of a stream |
| Ncontext | |
| Ccopy_fn | A function object that copies rows from one database context to a specified path, with optional column selection |
| Ccount_fn | A function object that counts the number of rows in a database context |
| Cfilter_t | Representation of a filter |
| Cpull_fn | A function object that pulls rows from a database context as a coroutine, optionally filtering results and selecting specific columns |
| Cpush_fn | A function object that pushes rows into a database context as a coroutine, allowing for dynamic insertion of data |
| Cremove_all_fn | A function object that removes all rows from a database context |
| Cremove_fn | A function object that removes rows from a database context as a coroutine, yielding the identifiers of the removed rows |
| Ncore | This namespace contains core types and operations for the OXY-API library |
| Nblob | |
| Cget_fn | Retrieve the contents of a blob object from a container connection |
| Cmake_object_fn | Generate an object containing the given contents |
| Cpush_fn | Push a blob object to a container connection |
| Nmetadata | |
| CAllOfExpr | Logical AND across expression-level nodes |
| CAllOfValue | Logical AND across value-level nodes |
| CAnyOfExpr | Logical OR across expression-level nodes |
| CAnyOfValue | Logical OR across value-level nodes |
| CExprNode | Variant for expression-level boolean expressions |
| CFieldCondition | A single field comparison against one or more values |
| CNotExpr | Logical negation of an expression-level node |
| CNotValue | Logical negation of a value-level node |
| CParseError | Exception type thrown when parsing fails |
| CParser | Parse textual queries into an expression AST |
| CSqlConfig | Configuration structure for SQL database interactions |
| CSqlGenerator | Emits SQL WHERE clauses or SELECT statements for a parsed query AST |
| CValue | A single scalar token appearing as a value in the query |
| CValueNode | Variant for value-level boolean expressions |
| Nobject | This namespace contains function objects and operations related to object management in the oxy library |
| Ccreate_filter_fn | Function object to create a filter in the database |
| Cexcept_fn | Function object to exclude objects from the container |
| Cget_data_fn | Function object to retrieve data associated with objects in the container |
| Cget_fn | Function object to retrieve objects from the container |
| Cget_when_fn | Function object to retrieve the timestamp associated with an object in the container |
| Cintersect_fn | Function object to intersect objects in the container |
| Cpull_fn | Function object to pull objects and their contents from the container |
| Cpull_oid_fn | Function object to pull OIDs from the container |
| Cpush_fn | Function object to push objects and their contents to the container |
| Cremove_fn | Function object to remove objects from the container |
| Nplugin | This namespace contains function objects and operations related to plugin management |
| Cget_files_fn | Function object to enumerate plugin files in a specified folder |
| Cget_folders_fn | Function object to enumerate plugin folders |
| Cget_library_fn | Function object to retrieve a shared library from a specified folder based on a symbol name |
| Cconfig_path_t | Singleton structure to hold the default configuration file path |
| Ccreate_schemas_fn | Function object to create database schemas |
| Cenum_parents_fn | Function object to enumerate the parents of a commit |
| Cexpand_fn | Function object to expand environment variables in settings paths |
| Cfind_common_ancestor_fn | Function object to find a common ancestor for two commits |
| Cget_commit_fn | Function object to get a commit |
| Cget_fn | Function object to retrieve settings, either from the default configuration file or a specified file |
| Cget_index_fn | Function object to retrieve an index from a connection and an OID or object |
| Cget_ref_fn | Function object to retrieve references from a connection |
| Cget_ref_when_fn | Function object to retrieve the timestamp of a reference from a connection |
| Cget_reference_fn | Function object to retrieve a specific reference from a connection |
| Cget_references_fn | Function object to retrieve all references from a connection |
| Cload_fn | Function object to load settings from an INI file |
| Cmake_blob_f | Generate a blob containing the given content |
| Cmake_commit_fn | Function object to create a commit in a container |
| Cmake_index_fn | Function object to create an index from a connection and an index item |
| Cmake_stream_f | Function object to create a stream from various input types |
| Cpull_oid_fn | Function object to enumerate the commits in a container |
| Cpush_commit_fn | Function object to push a commit in a container |
| Cpush_index_fn | Function object to push an index item to a connection |
| Cpush_ref_fn | Function object to push a reference to a connection |
| Cremove_quote_fn | Function object to remove quotes from a string |
| Cremove_ref_fn | Function object to remove a reference from a connection |
| Cset_fn | A function object that writes properties to an INI configuration file |
| Cset_reference_fn | Function object to set a reference in a connection |
| Csettings_t | Configuration settings for the oxy core library |
| Cports_t | Defines port numbers for container and directory services |
| Ndetail | |
| Cwin32_error_category | Custom error category for Win32 error codes, providing descriptive names and messages |
| Nfilter | This namespace contains function objects and operations related to filter management |
| Ccopy_fn | A function object that copies data from a source context to a destination context |
| Cdestination_t | Represents the destination context for the copy operation |
| Csource_t | Represents the source context for the copy operation |
| Ccreate_fn | Function object to create a filter |
| Cdrop_fn | Function object to drop a filter |
| Cexcept_fn | A function object that performs an except operation on a database (container) context, yielding the results as a coroutine |
| Cintersect_fn | A function object that performs an intersection operation on a database (container) context, yielding the results as a coroutine |
| Cpush_fn | Function object to push a filter |
| Cattach_fn | Function object to attach a SQLite database to an existing connection |
| Cblob_t | In-memory representation of a blob object |
| Ccategory_link_t | In-memory representation of a link betwin an oid and a category |
| Ccategory_t | In-memory representation of a category |
| Ccommit_t | In-memory representation of a commit |
| Cconnect_fn | Function object to establish a connection to a SQLite database |
| Cconnection_t | Representation of a sqlite's connection |
| Ccontents_t | In-memory representation of a contents |
| Ccontext_t | Representation of a context |
| Ccopy_fn | Function object to copy a table or filtered data from one SQLite database to another |
| Ccount_fn | Function object to count entries in a schema of a SQLite database |
| Ccreate_filter_fn | Function object to create a filter in a SQLite database |
| Cdetach_fn | Function object to detach a SQLite database from an existing connection |
| Centry_t | Representation of an entry of an index |
| Cenum_file_fn | Function object to enumerate files in a directory |
| Cexec_fn | Function object to execute a SQL statement on a SQLite database connection |
| CexpandEnvVar_fn | Function object to expand environment variables in strings and paths |
| Cformat_message_fn | Functor to format messages based on message IDs |
| Cget_envvar_fn | Function object to get the value of an environment variable |
| Cget_oid_fn | Get the identifier of an Oxy object |
| Cget_timestamp_fn | Function object to retrieve the current timestamp as a string |
| Chash_fn | Functor to compute SHA-1 hashes for various input types |
| Cindex_t | In-memory representation of a index object |
| Cmake_balanced_filters_fn | Function object to create balanced word filters based on the maximum number of filters |
| Cmake_dynamic_filters_fn | Function object to dynamically create word filters based on the maximum number of inputs per filter |
| Cmake_object_fn | Function object to generate an object containing the given contents and type |
| Cmake_tmpfile_fn | Function object to create a unique temporary file path with a specified extension |
| Cmanifest_t | In-memory representation of a manifest |
| Cmetadata_t | In-memory representation of a metadata |
| Cmime_t | Representation of a MIME code |
| Cobject_t | Representation of an OXY object |
| Coid_t | Unique identity of any object |
| CPathRemover | Custom deleter for std::filesystem::path that removes the file or directory when the unique_ptr goes out of scope |
| Cpush_fn | Function object to push items to a filter in a SQLite database |
| Cpush_optional_f | Functor to push an optional value into a JSON object |
| Crecord_t | In-memory representation of a record |
| Cscope_exit | A utility for executing a function upon exiting a scope |
| Cset_envVar_fn | Function object to set the value of an environment variable |
| Cset_value_f | Functor to set a value in a JSON object |
| Csha1sum_fn | Function object to compute SHA-1 checksums of files and streams |
| Csignature_t | In-memory representation of a signature |
| Cstream_t | In-memory representation of a stream |
| Ctag_link_t | In-memory representation of a link betwin an oid and a tag |
| Ctag_t | In-memory representation of a tag |
| Ctags_t | In-memory representation of a collection of tag |
| Ctimestamp_t | In-memory representation of the timestamp |
| Cupdate_fn | Function object to update a table in a SQLite database |
| Cwin32_error_code | A wrapper for Win32 error codes to facilitate conversion to std::error_code |
| Nstd | STL namespace |
| Cis_error_code_enum< oxy::win32_error_code > | Specialization of std::is_error_code_enum for oxy::win32_error_code |