OXY API 1.0
OXY API Library Documentation
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 NoxyThis root namespace contains the common types and operations for the OXY-API library
 NapiThis namespace contains the high-level definitions and operations for the OXY-API library
 NcontainerThis namespace contains function objects and operations related to container storage management in the OXY-API
 Cfrom_record_fnFunction object to convert a record to a manifest
 Cget_manifest_fnFunction object to retrieve the manifest from a container storage
 Cget_metadata_fnFunction object to retrieve metadata from a container storage
 Cget_path_fnFunction object to retrieve the filesystem path associated with a given OID
 Cget_record_fnFunction object to retrieve a record from a container storage
 Cset_manifest_fnFunction object to set the manifest in a container storage
 Cset_metadata_fnFunction object to set metadata in a container storage
 Cto_record_fnFunction object to convert a manifest and container OID to a record
 NmetadataThis namespace contains function objects and operations related to container metadata management in the metadata database
 NcategoryThis namespace contains function objects and operations related to categories in the metadata database
 Ccount_fnFunction object to count categories in the metadata database based on a where clause
 Cprepare_fnFunction object to prepare the category management in the metadata database
 Cpull_fnFunction object to pull the categories from the metadata database
 Cpush_fnFunction object to push categories to the metadata database
 Cpush_link_fnFunction object to push category links to the metadata database
 Cremove_all_fnFunction object to remove all categories from the metadata database
 Cremove_fnFunction object to remove categories from the metadata database
 Cselect_fnFunction object to select categories from the metadata database based on a where clause
 NtagThis namespace contains function objects and operations related to tags in the metadata database
 Ccount_fnFunction object to count tags in the metadata database based on a where clause
 Cprepare_fnFunction object to prepare the tag management in the metadata database
 Cpull_fnFunction object to pull the tags from the metadata database
 Cpush_fnFunction object to push the tags to the metadata database
 Cpush_link_fnFunction object to push tag links to the metadata database
 Cremove_all_fnFunction object to remove all tags from the metadata database
 Cremove_fnFunction object to remove tags from the metadata database
 Cselect_fnFunction object to select tags from the metadata database based on a where clause
 Ccopy_fnFunction object to copy metadata from one context to another
 Ccount_fnFunction object to count the number of records in the container metadata database
 Cgen_where_fnFunction object to generate a WHERE clause from an expression
 Cget_context_fnFunction object to retrieve a context for container metadata record operations in the metadata database
 Cget_fnFunction object to retrieve a container metadata record and its timestamp from the metadata database
 Cmerge_fnFunction object to merge metadata from one context into another
 Cpull_fnFunction object to pull container metadata records and their timestamps from the metadata database
 Cpush_fnFunction object to push records into the container metadata database
 Cpush_time_stamped_fnFunction object to push records with timestamps into the container metadata database
 Cremove_all_fnFunction object to remove all records from the container metadata database
 Cremove_fnFunction object to remove records from the container metadata database
 Cselect_fnFunction object to select OIDs from the container metadata database based on an expression
 NsettingsThis namespace contains function objects and operations related to application settings
 Cconfig_path_tRepresents the default configuration file path for the application
 Cexpand_fnFunction object to expand environment variables in settings paths
 Cget_fnFunction object to retrieve the application settings
 Cload_fnFunction object to load settings from an INI configuration file
 Cremove_quote_fnFunction object to remove quotes from a string
 Csettings_tRepresents the configuration settings for the application
 Cexport_contents_fnFunction object to export contents from a storage container to a file in the oxy API
 Cget_commit_fnFunction object to retrieve a commit from the storage container in the OXY-API
 Cget_contents_fnFunction object to retrieve contents from a storage container in the OXY-API
 Cget_entry_fnFunction object to retrieve an entry from the storage container in the OXY-API
 Cget_index_fnFunction object to retrieve the index from a storage container in the OXY-API
 Cget_references_fnFunction object to retrieve references from a storage container in the OXY-API
 Cimport_contents_fnFunction object to import contents from a file into a storage container in the OXY-API
 CIStorageInterface for storage operations in the OXY-API
 Cmake_commit_fnFunction object to create a commit in the storage container in the OXY-API
 Cmake_entry_fnFunction object to create an entry in the storage container in the OXY-API
 Cmanifest_tIn-memory representation of a manifest
 Copen_storage_fnFunction object to open a storage container connection in the OXY-API
 Cremove_entry_fnFunction object to remove an entry from the storage container in the OXY-API
 Cset_contents_fnFunction object to set contents in a storage container in the OXY-API
 Cset_entry_fnFunction object to set an entry in the storage container in the OXY-API
 Cstream_tIn-memory representation of a stream
 Ncontext
 Ccopy_fnA function object that copies rows from one database context to a specified path, with optional column selection
 Ccount_fnA function object that counts the number of rows in a database context
 Cfilter_tRepresentation of a filter
 Cpull_fnA function object that pulls rows from a database context as a coroutine, optionally filtering results and selecting specific columns
 Cpush_fnA function object that pushes rows into a database context as a coroutine, allowing for dynamic insertion of data
 Cremove_all_fnA function object that removes all rows from a database context
 Cremove_fnA function object that removes rows from a database context as a coroutine, yielding the identifiers of the removed rows
 NcoreThis namespace contains core types and operations for the OXY-API library
 Nblob
 Cget_fnRetrieve the contents of a blob object from a container connection
 Cmake_object_fnGenerate an object containing the given contents
 Cpush_fnPush a blob object to a container connection
 Nmetadata
 CAllOfExprLogical AND across expression-level nodes
 CAllOfValueLogical AND across value-level nodes
 CAnyOfExprLogical OR across expression-level nodes
 CAnyOfValueLogical OR across value-level nodes
 CExprNodeVariant for expression-level boolean expressions
 CFieldConditionA single field comparison against one or more values
 CNotExprLogical negation of an expression-level node
 CNotValueLogical negation of a value-level node
 CParseErrorException type thrown when parsing fails
 CParserParse textual queries into an expression AST
 CSqlConfigConfiguration structure for SQL database interactions
 CSqlGeneratorEmits SQL WHERE clauses or SELECT statements for a parsed query AST
 CValueA single scalar token appearing as a value in the query
 CValueNodeVariant for value-level boolean expressions
 NobjectThis namespace contains function objects and operations related to object management in the oxy library
 Ccreate_filter_fnFunction object to create a filter in the database
 Cexcept_fnFunction object to exclude objects from the container
 Cget_data_fnFunction object to retrieve data associated with objects in the container
 Cget_fnFunction object to retrieve objects from the container
 Cget_when_fnFunction object to retrieve the timestamp associated with an object in the container
 Cintersect_fnFunction object to intersect objects in the container
 Cpull_fnFunction object to pull objects and their contents from the container
 Cpull_oid_fnFunction object to pull OIDs from the container
 Cpush_fnFunction object to push objects and their contents to the container
 Cremove_fnFunction object to remove objects from the container
 NpluginThis namespace contains function objects and operations related to plugin management
 Cget_files_fnFunction object to enumerate plugin files in a specified folder
 Cget_folders_fnFunction object to enumerate plugin folders
 Cget_library_fnFunction object to retrieve a shared library from a specified folder based on a symbol name
 Cconfig_path_tSingleton structure to hold the default configuration file path
 Ccreate_schemas_fnFunction object to create database schemas
 Cenum_parents_fnFunction object to enumerate the parents of a commit
 Cexpand_fnFunction object to expand environment variables in settings paths
 Cfind_common_ancestor_fnFunction object to find a common ancestor for two commits
 Cget_commit_fnFunction object to get a commit
 Cget_fnFunction object to retrieve settings, either from the default configuration file or a specified file
 Cget_index_fnFunction object to retrieve an index from a connection and an OID or object
 Cget_ref_fnFunction object to retrieve references from a connection
 Cget_ref_when_fnFunction object to retrieve the timestamp of a reference from a connection
 Cget_reference_fnFunction object to retrieve a specific reference from a connection
 Cget_references_fnFunction object to retrieve all references from a connection
 Cload_fnFunction object to load settings from an INI file
 Cmake_blob_fGenerate a blob containing the given content
 Cmake_commit_fnFunction object to create a commit in a container
 Cmake_index_fnFunction object to create an index from a connection and an index item
 Cmake_stream_fFunction object to create a stream from various input types
 Cpull_oid_fnFunction object to enumerate the commits in a container
 Cpush_commit_fnFunction object to push a commit in a container
 Cpush_index_fnFunction object to push an index item to a connection
 Cpush_ref_fnFunction object to push a reference to a connection
 Cremove_quote_fnFunction object to remove quotes from a string
 Cremove_ref_fnFunction object to remove a reference from a connection
 Cset_fnA function object that writes properties to an INI configuration file
 Cset_reference_fnFunction object to set a reference in a connection
 Csettings_tConfiguration settings for the oxy core library
 Cports_tDefines port numbers for container and directory services
 Ndetail
 Cwin32_error_categoryCustom error category for Win32 error codes, providing descriptive names and messages
 NfilterThis namespace contains function objects and operations related to filter management
 Ccopy_fnA function object that copies data from a source context to a destination context
 Cdestination_tRepresents the destination context for the copy operation
 Csource_tRepresents the source context for the copy operation
 Ccreate_fnFunction object to create a filter
 Cdrop_fnFunction object to drop a filter
 Cexcept_fnA function object that performs an except operation on a database (container) context, yielding the results as a coroutine
 Cintersect_fnA function object that performs an intersection operation on a database (container) context, yielding the results as a coroutine
 Cpush_fnFunction object to push a filter
 Cattach_fnFunction object to attach a SQLite database to an existing connection
 Cblob_tIn-memory representation of a blob object
 Ccategory_link_tIn-memory representation of a link betwin an oid and a category
 Ccategory_tIn-memory representation of a category
 Ccommit_tIn-memory representation of a commit
 Cconnect_fnFunction object to establish a connection to a SQLite database
 Cconnection_tRepresentation of a sqlite's connection
 Ccontents_tIn-memory representation of a contents
 Ccontext_tRepresentation of a context
 Ccopy_fnFunction object to copy a table or filtered data from one SQLite database to another
 Ccount_fnFunction object to count entries in a schema of a SQLite database
 Ccreate_filter_fnFunction object to create a filter in a SQLite database
 Cdetach_fnFunction object to detach a SQLite database from an existing connection
 Centry_tRepresentation of an entry of an index
 Cenum_file_fnFunction object to enumerate files in a directory
 Cexec_fnFunction object to execute a SQL statement on a SQLite database connection
 CexpandEnvVar_fnFunction object to expand environment variables in strings and paths
 Cformat_message_fnFunctor to format messages based on message IDs
 Cget_envvar_fnFunction object to get the value of an environment variable
 Cget_oid_fnGet the identifier of an Oxy object
 Cget_timestamp_fnFunction object to retrieve the current timestamp as a string
 Chash_fnFunctor to compute SHA-1 hashes for various input types
 Cindex_tIn-memory representation of a index object
 Cmake_balanced_filters_fnFunction object to create balanced word filters based on the maximum number of filters
 Cmake_dynamic_filters_fnFunction object to dynamically create word filters based on the maximum number of inputs per filter
 Cmake_object_fnFunction object to generate an object containing the given contents and type
 Cmake_tmpfile_fnFunction object to create a unique temporary file path with a specified extension
 Cmanifest_tIn-memory representation of a manifest
 Cmetadata_tIn-memory representation of a metadata
 Cmime_tRepresentation of a MIME code
 Cobject_tRepresentation of an OXY object
 Coid_tUnique identity of any object
 CPathRemoverCustom deleter for std::filesystem::path that removes the file or directory when the unique_ptr goes out of scope
 Cpush_fnFunction object to push items to a filter in a SQLite database
 Cpush_optional_fFunctor to push an optional value into a JSON object
 Crecord_tIn-memory representation of a record
 Cscope_exitA utility for executing a function upon exiting a scope
 Cset_envVar_fnFunction object to set the value of an environment variable
 Cset_value_fFunctor to set a value in a JSON object
 Csha1sum_fnFunction object to compute SHA-1 checksums of files and streams
 Csignature_tIn-memory representation of a signature
 Cstream_tIn-memory representation of a stream
 Ctag_link_tIn-memory representation of a link betwin an oid and a tag
 Ctag_tIn-memory representation of a tag
 Ctags_tIn-memory representation of a collection of tag
 Ctimestamp_tIn-memory representation of the timestamp
 Cupdate_fnFunction object to update a table in a SQLite database
 Cwin32_error_codeA wrapper for Win32 error codes to facilitate conversion to std::error_code
 NstdSTL namespace
 Cis_error_code_enum< oxy::win32_error_code >Specialization of std::is_error_code_enum for oxy::win32_error_code