Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
207 lines
17 KiB
HTML
207 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>SERiF: src/include/serif/utils/serialize/archive.hpp File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">SERiF<span id="projectnumber"> v0.0.1a</span>
|
|
</div>
|
|
<div id="projectbrief">Stellar Evolution and Rotation in Four Dimensions</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('archive_8hpp.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">archive.hpp File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <cstddef></code><br />
|
|
<code>#include <filesystem></code><br />
|
|
<code>#include <fstream></code><br />
|
|
<code>#include <map></code><br />
|
|
<code>#include <optional></code><br />
|
|
<code>#include <string></code><br />
|
|
<code>#include <string_view></code><br />
|
|
<code>#include <vector></code><br />
|
|
<code>#include "<a class="el" href="record_8hpp.html">serif/utils/serialize/record.hpp</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for archive.hpp:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="archive_8hpp__incl.svg" width="100%" height="460"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
|
|
</div>
|
|
</div><div class="textblock"><div class="dynheader">
|
|
This graph shows which files directly or indirectly include this file:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="archive_8hpp__dep__incl.svg" width="100%" height="472"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
|
|
</div>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1utils_1_1serialize_1_1_write_options.html">serif::utils::serialize::WriteOptions</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Annotations belong to the written observation, not to the stellar physics. <a href="structserif_1_1utils_1_1serialize_1_1_write_options.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1utils_1_1serialize_1_1_read_options.html">serif::utils::serialize::ReadOptions</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Bound resource use when inspecting an unfamiliar archive; limits may be raised explicitly. <a href="structserif_1_1utils_1_1serialize_1_1_read_options.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1utils_1_1serialize_1_1_entry.html">serif::utils::serialize::Entry</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The ledger locates each independent field without decoding the rest of the archive. <a href="structserif_1_1utils_1_1serialize_1_1_entry.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserif_1_1utils_1_1serialize_1_1_pack.html">serif::utils::serialize::Pack</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A pack owns its data immediately, so subsequent model changes cannot alter a pending write. <a href="structserif_1_1utils_1_1serialize_1_1_pack.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classserif_1_1utils_1_1serialize_1_1_reader.html">serif::utils::serialize::Reader</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Inspect the ledger first, then seek directly to whichever components are actually needed. <a href="classserif_1_1utils_1_1serialize_1_1_reader.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif.html">serif</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils.html">serif::utils</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html">serif::utils::serialize</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:af59ceea5df9600e1e8c0e762e6b08c99" id="r_af59ceea5df9600e1e8c0e762e6b08c99"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#af59ceea5df9600e1e8c0e762e6b08c99">serif::utils::serialize::Format</a> { <a class="el" href="namespaceserif_1_1utils_1_1serialize.html#af59ceea5df9600e1e8c0e762e6b08c99a9d7183f16acce70658f686ae7f1a4d20">serif::utils::serialize::binary</a>
|
|
, <a class="el" href="namespaceserif_1_1utils_1_1serialize.html#af59ceea5df9600e1e8c0e762e6b08c99a1cb251ec0d568de6a929b520c4aed8d1">serif::utils::serialize::text</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:af59ceea5df9600e1e8c0e762e6b08c99"><td class="mdescLeft"> </td><td class="mdescRight">Both encodings share the same component schemas and indexed, sectioned file layout. <a href="namespaceserif_1_1utils_1_1serialize.html#af59ceea5df9600e1e8c0e762e6b08c99">More...</a><br /></td></tr>
|
|
<tr class="separator:af59ceea5df9600e1e8c0e762e6b08c99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02674e30cfb576e300d365827de17279" id="r_a02674e30cfb576e300d365827de17279"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#a02674e30cfb576e300d365827de17279">serif::utils::serialize::VersionTolerance</a> { <a class="el" href="namespaceserif_1_1utils_1_1serialize.html#a02674e30cfb576e300d365827de17279ae79a3672fcb675134bb57abd3e0dfae3">serif::utils::serialize::same_major</a>
|
|
, <a class="el" href="namespaceserif_1_1utils_1_1serialize.html#a02674e30cfb576e300d365827de17279a3b7efa09444a31c5d58596e5bbf87d47">serif::utils::serialize::exact</a>
|
|
, <a class="el" href="namespaceserif_1_1utils_1_1serialize.html#a02674e30cfb576e300d365827de17279a100b8cad7cf2a56f6df78f171f97a1ec">serif::utils::serialize::any</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a02674e30cfb576e300d365827de17279"><td class="mdescLeft"> </td><td class="mdescRight">Application-version compatibility is separate from file-format and component-schema compatibility. <a href="namespaceserif_1_1utils_1_1serialize.html#a02674e30cfb576e300d365827de17279">More...</a><br /></td></tr>
|
|
<tr class="separator:a02674e30cfb576e300d365827de17279"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ab93715bd271d15568badc8f1d5423271" id="r_ab93715bd271d15568badc8f1d5423271"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:ab93715bd271d15568badc8f1d5423271"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structserif_1_1utils_1_1serialize_1_1_field.html">Field</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#ab93715bd271d15568badc8f1d5423271">serif::utils::serialize::named</a> (std::string name, const T &value)</td></tr>
|
|
<tr class="memdesc:ab93715bd271d15568badc8f1d5423271"><td class="mdescLeft"> </td><td class="mdescRight">Assign an explicit top-level name, for example when storing two stars in the same archive. <br /></td></tr>
|
|
<tr class="separator:ab93715bd271d15568badc8f1d5423271"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f4727c3a8f5b10ed46c149785bd8c82" id="r_a7f4727c3a8f5b10ed46c149785bd8c82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#a7f4727c3a8f5b10ed46c149785bd8c82">serif::utils::serialize::add_component</a> (<a class="el" href="structserif_1_1utils_1_1serialize_1_1_pack.html">Pack</a> &<a class="el" href="namespaceserif_1_1utils_1_1serialize.html#ad8a45ed21a6cf9a7ca63582a18526f9b">pack</a>, <a class="el" href="structserif_1_1utils_1_1serialize_1_1_field.html">Field</a> component)</td></tr>
|
|
<tr class="memdesc:a7f4727c3a8f5b10ed46c149785bd8c82"><td class="mdescLeft"> </td><td class="mdescRight">Insert a component while rejecting conflicting definitions of the same named object. <br /></td></tr>
|
|
<tr class="separator:a7f4727c3a8f5b10ed46c149785bd8c82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8a45ed21a6cf9a7ca63582a18526f9b" id="r_ad8a45ed21a6cf9a7ca63582a18526f9b"><td class="memTemplParams" colspan="2">template<typename... T> </td></tr>
|
|
<tr class="memitem:ad8a45ed21a6cf9a7ca63582a18526f9b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structserif_1_1utils_1_1serialize_1_1_pack.html">Pack</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#ad8a45ed21a6cf9a7ca63582a18526f9b">serif::utils::serialize::pack</a> (const T &... values)</td></tr>
|
|
<tr class="memdesc:ad8a45ed21a6cf9a7ca63582a18526f9b"><td class="mdescLeft"> </td><td class="mdescRight">Capture every supplied component; unregistered nested types remain visible as unsupported entries. <br /></td></tr>
|
|
<tr class="separator:ad8a45ed21a6cf9a7ca63582a18526f9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53de7b4a0d01bed188ef53fbeb4c3e7e" id="r_a53de7b4a0d01bed188ef53fbeb4c3e7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#ace9e0af29889a767ef1c95a09a4b7265">Result</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1utils_1_1serialize.html#a53de7b4a0d01bed188ef53fbeb4c3e7e">serif::utils::serialize::write</a> (const std::filesystem::path &path, const <a class="el" href="structserif_1_1utils_1_1serialize_1_1_pack.html">Pack</a> &contents, const <a class="el" href="structserif_1_1utils_1_1serialize_1_1_write_options.html">WriteOptions</a> &options={})</td></tr>
|
|
<tr class="memdesc:a53de7b4a0d01bed188ef53fbeb4c3e7e"><td class="mdescLeft"> </td><td class="mdescRight">Write a complete temporary file and atomically replace the destination only after it closes successfully. <br /></td></tr>
|
|
<tr class="separator:a53de7b4a0d01bed188ef53fbeb4c3e7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a></li><li class="navelem"><a class="el" href="dir_0fcf4c89a1274e6563f11975b8f6a431.html">utils</a></li><li class="navelem"><a class="el" href="dir_ae4e54e2b3dd44e066c26d6c78043d75.html">serialize</a></li><li class="navelem"><a class="el" href="archive_8hpp.html">archive.hpp</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|