file.h

Go to the documentation of this file.

 
#pragma once
 
#include <memory>
#include <span>
#include <string_view>
 
#include <rex/filesystem/directory.h>
#include <rex/filesystem/file_open.h>
#include <rex/filesystem/file_stat.h>
#include <rex/result.h>
#include <rex/types.h>
#include <rex/utility.h>
 
namespace rex::filesystem {

class IFile : public NonCopyable {
 public:
  virtual ~IFile() = default;
 
  [[nodiscard]] virtual FileStat GetInfo() const = 0;

  virtual void Refresh() = 0;

  [[nodiscard]] virtual Access GetAccess() const = 0;
 
  [[nodiscard]] virtual VolumeStat GetVolume() const = 0;

  [[nodiscard]] virtual Result<size_t> Read(std::span<u8> buffer, u64 offset) = 0;

  [[nodiscard]] virtual Result<size_t> Write(std::span<const u8> buffer, u64 offset) = 0;

  [[nodiscard]] virtual Result<void> SetLength(u64 length) = 0;
 
  [[nodiscard]] virtual Result<void> Flush() = 0;
 
  [[nodiscard]] virtual Result<void> SetAttributes(FileAttributes attributes) = 0;

  [[nodiscard]] virtual Result<void> SetTimes(const FileTimes& times) = 0;
 
  virtual void SetDeleteOnClose(bool delete_on_close) = 0;

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

  [[nodiscard]] virtual Result<std::span<const u8>> View() = 0;
};
 
struct Opened {
  std::unique_ptr<IFile> file;
  OpenAction action = OpenAction::kOpened;
};
 
}  // namespace rex::filesystem