summaryrefslogtreecommitdiff
path: root/src/io.hh
blob: 7c2102872b484dbfe826cbb66ab7279c5870d33a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#ifndef IO_HH
#define IO_HH

#include <cstddef>
#include <expected>
#include <memory>
#include <string>

namespace io {

enum class ReadError {
  Error,
  Eof,
  InvalidData,  // invalid data read (not used by raw file)
  MaxTooSmall,  // max argument needs to be bigger (not used by raw file)
};

enum class OpenError {
  NoSuchFile,
  NoAccess,
  Error,
};

class Reader {
 public:
  virtual ~Reader() = default;

  [[nodiscard]] virtual std::expected<size_t, ReadError> read(void* dst,
                                                              size_t max) = 0;
  [[nodiscard]] virtual std::expected<size_t, ReadError> skip(size_t max) = 0;

  [[nodiscard]] std::expected<size_t, ReadError> repeat_read(void* dst,
                                                             size_t max);
  [[nodiscard]] std::expected<size_t, ReadError> repeat_skip(size_t max);

 protected:
  Reader() = default;

  Reader(Reader const&) = delete;
  Reader& operator=(Reader const&) = delete;
};

[[nodiscard]] std::expected<std::unique_ptr<Reader>, OpenError> open(
    const std::string& file_path);
[[nodiscard]] std::expected<std::unique_ptr<Reader>, OpenError> openat(
    int dirfd, const std::string& file_path);
[[nodiscard]] std::unique_ptr<Reader> memory(std::string data);

}  // namespace io

#endif  // IO_HH