OXY API 1.0
OXY API Library Documentation
Loading...
Searching...
No Matches
oxy::core::plugin::get_files_fn Struct Reference

Function object to enumerate plugin files in a specified folder. More...

#include <plugin.hpp>

Public Types

using coro_t = boost::coroutines2::coroutine<std::filesystem::path>

Public Member Functions

auto operator() (std::filesystem::path const &folder) const -> coro_t::pull_type

Detailed Description

Function object to enumerate plugin files in a specified folder.

This functor provides a coroutine-based interface to enumerate plugin files within a specified folder. It allows for lazy evaluation of files in the given directory, yielding file paths as they are discovered. The coroutine pull type enables efficient processing of file paths without blocking the main execution flow. The operator() takes a folder path as input and returns a coroutine pull type that yields file paths within that folder.

Member Function Documentation

◆ operator()()

auto oxy::core::plugin::get_files_fn::operator() ( std::filesystem::path const & folder) const -> coro_t::pull_type
Parameters
folder- The path of the folder to enumerate files from.
Returns
A coroutine pull type that yields file paths within the specified folder.