read.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/fs/blocking/read.hpp
/// @brief functions for synchronous (blocking) file read operations
/// @ingroup userver_universal
 
#include <cstddef>
#include <limits>
 
#include <userver/fs/file_info_with_data.hpp>
#include <userver/fs/settings_read_file.hpp>
#include <userver/utils/boost_filesystem_file_status.hpp>
#include <userver/utils/zstring_view.hpp>
 
USERVER_NAMESPACE_BEGIN
 
/// @brief blocking function and classes to work with filesystem
///
/// Use these with caution as they block current thread.  It is probably OK to
/// use them during startup (on component load), but don't use them after server
/// start in the main TaskProcessor. Use asynchronous alternatives from `fs`
/// namespace instead.
namespace fs::blocking {
 
/// @brief Reads file contents synchronously
/// @param path file to open
/// @returns file contents
/// @throws std::runtime_error if read fails for any reason (e.g. no such file,
/// read error, etc.),
std::string ReadFileContents(utils::zstring_view path);
 
/// @brief Checks whether the file exists synchronously
/// @param path file path to check
/// @returns true if file exists, false if file doesn't exist
/// @throws std::runtime_error if something goes wrong (e.g. out of file
/// descriptors)
bool FileExists(utils::zstring_view path);
 
/// @brief Get file type returned by stat(2) synchronously.
/// @param path file path
/// @throws std::runtime_error if something goes wrong
boost::filesystem::file_type GetFileType(utils::zstring_view path);
 
/// @brief Returns files from recursively traversed directory
/// @param path to directory to traverse recursively
/// @param flags settings read files
/// @param max_size_to_cache files larger than this store a full path in
/// `FileInfoWithData::data_or_path` instead of contents
/// @returns map with relative to `path` filepaths and file info
/// @throws std::runtime_error if read fails for any reason (e.g. no such file,
/// read error, etc.),
FileInfoWithDataMap ReadRecursiveFilesInfoWithData(
    utils::zstring_view path,
    SettingReadFileFlags flags,
    std::size_t max_size_to_cache = std::numeric_limits<std::size_t>::max()
);
 
}  // namespace fs::blocking
 
USERVER_NAMESPACE_END