file_system.h

Go to the documentation of this file.

 
#pragma once
 
#include <filesystem>
#include <memory>
#include <optional>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
#include <rex/filesystem/directory.h>
#include <rex/filesystem/file.h>
#include <rex/filesystem/file_open.h>
#include <rex/filesystem/file_stat.h>
#include <rex/filesystem/file_system_error.h>
#include <rex/filesystem/mount.h>
#include <rex/memory/host.h>
#include <rex/result.h>
#include <rex/types.h>
#include <rex/utility.h>
 
namespace rex::filesystem {
 
inline constexpr memory::Tag kFilesystem{7};

class IFileSystem : public NonCopyable {
 public:
  virtual ~IFileSystem() = default;

  [[nodiscard]] virtual Result<void> Mount(const MountEntry& entry) = 0;

  [[nodiscard]] virtual Result<void> Unmount(std::string_view path) = 0;
 
  [[nodiscard]] virtual std::vector<MountEntry> GetMounts() const = 0;

  [[nodiscard]] virtual Result<void> Link(std::string_view link, std::string_view target) = 0;

  [[nodiscard]] virtual Result<void> Unlink(std::string_view link) = 0;

  [[nodiscard]] virtual std::optional<std::string> FindLink(std::string_view path) const = 0;

  [[nodiscard]] virtual Result<void> ConfigureStandardMounts(
      const std::filesystem::path& game_root, const std::filesystem::path& update_root,
      MountFlags game_flags) = 0;

  virtual void Clear() = 0;

  [[nodiscard]] virtual Result<Opened> Open(std::string_view path, const OpenOptions& options) = 0;

  [[nodiscard]] virtual Result<Opened> OpenRelative(IFile& root, std::string_view path,
                                                    const OpenOptions& options) = 0;

  [[nodiscard]] virtual Result<FileStat> Stat(std::string_view path) = 0;

  [[nodiscard]] virtual Result<std::unique_ptr<IDirectory>> List(std::string_view path,
                                                                 std::string_view pattern) = 0;

  [[nodiscard]] virtual Result<void> CreateDirectories(std::string_view path) = 0;

  [[nodiscard]] virtual Result<void> Remove(std::string_view path) = 0;

  [[nodiscard]] virtual Result<void> Rename(std::string_view from, std::string_view to,
                                            bool replace_existing) = 0;

  [[nodiscard]] virtual Result<void> Rename(IFile& file, std::string_view to, bool replace_existing,
                                            IFile* root = nullptr) = 0;

  [[nodiscard]] virtual Result<VolumeStat> GetVolume(std::string_view path) = 0;
};
 
}  // namespace rex::filesystem