.TH "src/include/serif/utils/serialize/archive.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/utils/serialize/archive.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <cstddef>\fP
.br
\fR#include <filesystem>\fP
.br
\fR#include <fstream>\fP
.br
\fR#include <map>\fP
.br
\fR#include <optional>\fP
.br
\fR#include <string>\fP
.br
\fR#include <string_view>\fP
.br
\fR#include <vector>\fP
.br
\fR#include 'serif/utils/serialize/record\&.hpp'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBserif::utils::serialize::WriteOptions\fP"
.br
.RI "Annotations belong to the written observation, not to the stellar physics\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::ReadOptions\fP"
.br
.RI "Bound resource use when inspecting an unfamiliar archive; limits may be raised explicitly\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Entry\fP"
.br
.RI "The ledger locates each independent field without decoding the rest of the archive\&. "
.ti -1c
.RI "struct \fBserif::utils::serialize::Pack\fP"
.br
.RI "A pack owns its data immediately, so subsequent model changes cannot alter a pending write\&. "
.ti -1c
.RI "class \fBserif::utils::serialize::Reader\fP"
.br
.RI "Inspect the ledger first, then seek directly to whichever components are actually needed\&. "
.in -1c
.SS "Namespaces"

.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils\fP"
.br
.ti -1c
.RI "namespace \fBserif::utils::serialize\fP"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum class \fBserif::utils::serialize::Format\fP { \fBserif::utils::serialize::binary\fP, \fBserif::utils::serialize::text\fP }"
.br
.RI "Both encodings share the same component schemas and indexed, sectioned file layout\&. "
.ti -1c
.RI "enum class \fBserif::utils::serialize::VersionTolerance\fP { \fBserif::utils::serialize::same_major\fP, \fBserif::utils::serialize::exact\fP, \fBserif::utils::serialize::any\fP }"
.br
.RI "Application-version compatibility is separate from file-format and component-schema compatibility\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "template<typename T> \fBField\fP \fBserif::utils::serialize::named\fP (std::string name, const T &value)"
.br
.RI "Assign an explicit top-level name, for example when storing two stars in the same archive\&. "
.ti -1c
.RI "void \fBserif::utils::serialize::add_component\fP (\fBPack\fP &\fBpack\fP, \fBField\fP component)"
.br
.RI "Insert a component while rejecting conflicting definitions of the same named object\&. "
.ti -1c
.RI "template<typename\&.\&.\&. T> \fBPack\fP \fBserif::utils::serialize::pack\fP (const T &\&.\&.\&. values)"
.br
.RI "Capture every supplied component; unregistered nested types remain visible as unsupported entries\&. "
.ti -1c
.RI "\fBResult\fP< void > \fBserif::utils::serialize::write\fP (const std::filesystem::path &path, const \fBPack\fP &contents, const \fBWriteOptions\fP &options={})"
.br
.RI "Write a complete temporary file and atomically replace the destination only after it closes successfully\&. "
.in -1c
.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.