summaryrefslogtreecommitdiff
path: root/includes/image_io/base/types.h
blob: aaa88b3b4050ecb1734532ed3ae9555e5bf70682 (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
#ifndef IMAGE_IO_BASE_TYPES_H_  // NOLINT
#define IMAGE_IO_BASE_TYPES_H_  // NOLINT

#include <cstdint>
#include <cstdlib>

namespace photos_editing_formats {
namespace image_io {

/// Byte is the noumenon unit of data.
using Byte = std::uint8_t;

/// A Byte value and a validity flag.
struct ValidatedByte {
  explicit ValidatedByte(Byte value_arg) : value(value_arg), is_valid(true) {}
  ValidatedByte(const ValidatedByte&) = default;
  ValidatedByte& operator=(const ValidatedByte&) = default;
  Byte value;
  bool is_valid;
};

/// Equality operator for ValidatedByte
inline bool operator==(const ValidatedByte& lhs, const ValidatedByte& rhs) {
  return lhs.value == rhs.value && lhs.is_valid == rhs.is_valid;
}

/// Inquality operator for ValidatedByte
inline bool operator!=(const ValidatedByte& lhs, const ValidatedByte& rhs) {
  return lhs.value != rhs.value || lhs.is_valid != rhs.is_valid;
}

/// @return a validated byte that has a false is_valid value.
inline ValidatedByte InvalidByte() {
  ValidatedByte invalid_byte(0);
  invalid_byte.is_valid = false;
  return invalid_byte;
}

}  // namespace image_io
}  // namespace photos_editing_formats

#endif // IMAGE_IO_BASE_TYPES_H_  // NOLINT