OXY API 1.0
OXY API Library Documentation
Loading...
Searching...
No Matches
oxy::api::get_references_fn Struct Reference

Function object to retrieve references from a storage container in the OXY-API. More...

#include <storage.hpp>

Public Member Functions

references operator() (connection_ptr const &conn) const
references operator() (IStoragePtr const &stg) const
references operator() (std::filesystem::path const &repo_path) const

Detailed Description

Function object to retrieve references from a storage container in the OXY-API.

This function object provides three operator() overloads: one that takes a connection pointer, another that takes a storage container pointer, and a third that takes a repository path. All overloads return a references map containing the references if available. It is designed to be used in a constexpr context for compile-time evaluation of reference retrieval operations.

Member Function Documentation

◆ operator()() [1/3]

references oxy::api::get_references_fn::operator() ( connection_ptr const & conn) const
Parameters
conn- The connection pointer to the container.
Returns
A references map containing the references if available.

◆ operator()() [2/3]

references oxy::api::get_references_fn::operator() ( IStoragePtr const & stg) const
inline
Parameters
stg- The storage container pointer from which to retrieve the references.
Returns
A references map containing the references if available.

◆ operator()() [3/3]

references oxy::api::get_references_fn::operator() ( std::filesystem::path const & repo_path) const
inline
Parameters
repo_path- The filesystem path to the repository from which to retrieve the references.
Returns
A references map containing the references if available.

References oxy::connect.