OXY-SYNC-DIRECTORY 1.0
OXY-SYNC-DIRECTORY Library Documentation
Loading...
Searching...
No Matches
directory.hpp File Reference

This file defines some of the core functionality for the library. More...

Classes

struct  oxy::directory::enum_missing_fn
 Function object for enumerating missing entries. More...
struct  oxy::directory::reset_settings_fn
 Function object for resetting the configuration settings to default values. More...
struct  oxy::directory::set_settings_fn
 Function object for setting the configuration settings from a file. More...

Namespaces

namespace  oxy::directory
 The oxy::directory namespace contains interfaces and functions for synchronizing and updating the metadata directory.

Variables

constexpr enum_missing_fn oxy::directory::enum_missing
 A constexpr instance of the enum_missing_fn function object for use in functional programming.
constexpr reset_settings_fn oxy::directory::reset_settings
 A constexpr instance of the reset_settings_fn function object for use in functional programming.
constexpr set_settings_fn oxy::directory::set_settings
 A constexpr instance of the set_settings_fn function object for use in functional programming.

Detailed Description

This file defines some of the core functionality for the library.

This file defines some of the core functionality for the library, including the reset_settings_fn, set_settings_fn, and enum_missing_fn function objects, which provide callable interfaces for resetting configuration settings, setting configuration settings from a file, and enumerating missing entries in the directory, respectively. These function objects can be used in functional programming contexts to perform the corresponding operations in a concise and expressive manner.

Note
The reset_settings_fn function object can be used to clear any custom configuration settings and revert to the default values, while the set_settings_fn function object can be used to apply custom configuration settings from a specified file. The enum_missing_fn function object provides a coroutine-based interface for enumerating missing metadatas in the directory, yielding tuples of object IDs and timestamps for further processing.
The use of coroutines in the enum_missing_fn function object allows for efficient and asynchronous processing of missing metadatas in the directory, enabling developers to handle large datasets and perform operations in a non-blocking manner. This design choice promotes scalability and responsiveness in applications that interact with the directory, allowing for efficient handling of missing metadatas and improved user experience.