Sourcemeta Core 0.0.0
Loading...
Searching...
No Matches
metapack_read.h
1#ifndef SOURCEMETA_CORE_METAPACK_READ_H_
2#define SOURCEMETA_CORE_METAPACK_READ_H_
3
4#ifndef SOURCEMETA_CORE_METAPACK_EXPORT
5#include <sourcemeta/core/metapack_export.h>
6#endif
7
8// NOLINTBEGIN(misc-include-cleaner)
9#include <sourcemeta/core/metapack_format.h>
10// NOLINTEND(misc-include-cleaner)
11
12#include <sourcemeta/core/io.h>
13#include <sourcemeta/core/json.h>
14
15#include <array> // std::array
16#include <chrono> // std::chrono::system_clock
17#include <cstdint> // std::uint8_t, std::uint64_t
18#include <filesystem> // std::filesystem::path
19#include <optional> // std::optional
20#include <span> // std::span
21#include <string_view> // std::string_view
22#include <type_traits> // std::is_trivially_copyable_v
23
24namespace sourcemeta::core {
25
29inline constexpr std::uint64_t METAPACK_MAXIMUM_DECOMPRESSION_RATIO{1024};
30
36 const MetapackHeader *header{nullptr};
38 std::string_view media_type;
40 std::span<const std::uint8_t> extension;
42 std::span<const std::uint8_t> payload;
43};
44
58SOURCEMETA_CORE_METAPACK_EXPORT
59auto metapack_parse(const FileView &view) -> std::optional<MetapackView>;
60
74SOURCEMETA_CORE_METAPACK_EXPORT
75auto metapack_read_json(const std::filesystem::path &path,
76 const std::uint64_t maximum_decompression_ratio =
78 -> std::optional<JSON>;
79
92SOURCEMETA_CORE_METAPACK_EXPORT
94 const std::uint64_t maximum_decompression_ratio =
96 -> std::optional<JSON>;
97
112SOURCEMETA_CORE_METAPACK_EXPORT
114 const std::uint64_t maximum_decompression_ratio =
116 -> std::optional<JSON>;
117
132SOURCEMETA_CORE_METAPACK_EXPORT
134 -> std::array<char, METAPACK_CHECKSUM_HEX_LENGTH>;
135
150SOURCEMETA_CORE_METAPACK_EXPORT
152 -> std::chrono::system_clock::time_point;
153
175template <typename T>
176auto metapack_extension_as(const std::span<const std::uint8_t> extension)
177 -> const T * {
178 static_assert(std::is_trivially_copyable_v<T>,
179 "An extension layout is read where it lies, so it has to be "
180 "trivially copyable");
181 static_assert(alignof(T) == 1,
182 "An extension begins at an offset the media type decides, so "
183 "its layout must be packed to be read where it lies");
184 if (extension.size() < sizeof(T)) {
185 return nullptr;
186 }
187
188 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
189 return reinterpret_cast<const T *>(extension.data());
190}
191
192} // namespace sourcemeta::core
193
194#endif
Definition io_fileview.h:32
const MetapackHeader * header
The metadata the file begins with.
Definition metapack_read.h:36
std::span< const std::uint8_t > extension
The extension area, as the bytes the writer put there.
Definition metapack_read.h:40
std::span< const std::uint8_t > payload
The contents, as stored.
Definition metapack_read.h:42
std::string_view media_type
The media type to serve the contents as.
Definition metapack_read.h:38
SOURCEMETA_CORE_METAPACK_EXPORT auto metapack_parse(const FileView &view) -> std::optional< MetapackView >
SOURCEMETA_CORE_METAPACK_EXPORT auto metapack_last_modified(const MetapackHeader &header) -> std::chrono::system_clock::time_point
auto metapack_extension_as(const std::span< const std::uint8_t > extension) -> const T *
Definition metapack_read.h:176
constexpr std::uint64_t METAPACK_MAXIMUM_DECOMPRESSION_RATIO
Definition metapack_read.h:29
SOURCEMETA_CORE_METAPACK_EXPORT auto metapack_checksum_hex(const MetapackHeader &header) -> std::array< char, METAPACK_CHECKSUM_HEX_LENGTH >
SOURCEMETA_CORE_METAPACK_EXPORT auto metapack_read_json(const std::filesystem::path &path, const std::uint64_t maximum_decompression_ratio=METAPACK_MAXIMUM_DECOMPRESSION_RATIO) -> std::optional< JSON >
Definition metapack_format.h:33
Definition metapack_read.h:34