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)
107 lines
4.3 KiB
Groff
107 lines
4.3 KiB
Groff
.TH "serif::utils::serialize::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::utils::serialize::detail
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Model> using \fBResolvedEquations\fP = decltype(\fBmodel::resolve_equilibrium_equations\fP(std::declval<const Model&>()))"
|
|
.br
|
|
.ti -1c
|
|
.RI "template<typename Model> using \fBOwnedEquations\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBResult\fP< std::optional< \fBequations::PointMassCompanion\fP > > \fBread_companion\fP (const \fBNode\fP &node)"
|
|
.br
|
|
.RI "Archives written before companions existed have no companion field; a single star stays one\&. "
|
|
.ti -1c
|
|
.RI "\fBNode\fP \fBwith_companion\fP (\fBNode\fP node, const std::optional< \fBequations::PointMassCompanion\fP > &companion)"
|
|
.br
|
|
.RI "Record the companion only when there is one, so single-star archives keep their schema\&. "
|
|
.ti -1c
|
|
.RI "std::uint64_t \fBvalue_count\fP (const \fBValue\fP &value)"
|
|
.br
|
|
.RI "Scalar types have one value; numerical arrays and strings carry their explicit extent\&. "
|
|
.ti -1c
|
|
.RI "std::string \fBencode_value\fP (const \fBValue\fP &value, \fBFormat\fP format)"
|
|
.br
|
|
.RI "Encode one indexed payload without relying on native object layout or byte order\&. "
|
|
.ti -1c
|
|
.RI "\fBResult\fP< \fBValue\fP > \fBdecode_value\fP (std::string_view bytes, const \fBEntry\fP &entry, \fBFormat\fP format)"
|
|
.br
|
|
.RI "Validate the extent and representation of an independently read payload\&. "
|
|
.ti -1c
|
|
.RI "bool \fBvalid_path\fP (std::string_view path)"
|
|
.br
|
|
.RI "Restrict field names so path separators and line breaks cannot corrupt the ledger\&. "
|
|
.ti -1c
|
|
.RI "\fBNode\fP \fBprovenance\fP (const \fBWriteOptions\fP &options)"
|
|
.br
|
|
.RI "Capture provenance once at the beginning of a write\&. "
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "constexpr std::uint64_t \fBheader_bytes\fP = 512"
|
|
.br
|
|
.in -1c
|
|
.SH "Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Model> using \fBserif::utils::serialize::detail::OwnedEquations\fP"
|
|
\fBInitial value:\fP
|
|
.nf
|
|
model::EquilibriumEquations<typename ResolvedEquations<Model>::InteriorEquations, typename ResolvedEquations<Model>::ShapeForce,
|
|
typename ResolvedEquations<Model>::SurfaceCondition>
|
|
.PP
|
|
.fi
|
|
|
|
.SS "template<typename Model> using \fBserif::utils::serialize::detail::ResolvedEquations\fP = decltype(\fBmodel::resolve_equilibrium_equations\fP(std::declval<const Model&>()))"
|
|
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "\fBResult\fP< \fBValue\fP > serif::utils::serialize::detail::decode_value (std::string_view bytes, const \fBEntry\fP & entry, \fBFormat\fP format)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Validate the extent and representation of an independently read payload\&.
|
|
.SS "std::string serif::utils::serialize::detail::encode_value (const \fBValue\fP & value, \fBFormat\fP format)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Encode one indexed payload without relying on native object layout or byte order\&. Emit one numerical value through the selected representation\&.
|
|
.SS "\fBNode\fP serif::utils::serialize::detail::provenance (const \fBWriteOptions\fP & options)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Capture provenance once at the beginning of a write\&.
|
|
.SS "\fBResult\fP< std::optional< \fBequations::PointMassCompanion\fP > > serif::utils::serialize::detail::read_companion (const \fBNode\fP & node)\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Archives written before companions existed have no companion field; a single star stays one\&.
|
|
.SS "bool serif::utils::serialize::detail::valid_path (std::string_view path)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Restrict field names so path separators and line breaks cannot corrupt the ledger\&.
|
|
.SS "std::uint64_t serif::utils::serialize::detail::value_count (const \fBValue\fP & value)\fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Scalar types have one value; numerical arrays and strings carry their explicit extent\&.
|
|
.SS "\fBNode\fP serif::utils::serialize::detail::with_companion (\fBNode\fP node, const std::optional< \fBequations::PointMassCompanion\fP > & companion)\fR [inline]\fP"
|
|
|
|
.PP
|
|
Record the companion only when there is one, so single-star archives keep their schema\&.
|
|
.SH "Variable Documentation"
|
|
.PP
|
|
.SS "std::uint64_t serif::utils::serialize::detail::header_bytes = 512\fR [inline]\fP, \fR [constexpr]\fP"
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|