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)
71 lines
1.8 KiB
Groff
71 lines
1.8 KiB
Groff
.TH "src/lib/serif/utils/serialize/format.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/utils/serialize/format.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'format\&.hpp'\fP
|
|
.br
|
|
\fR#include <bit>\fP
|
|
.br
|
|
\fR#include <charconv>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <iomanip>\fP
|
|
.br
|
|
\fR#include <limits>\fP
|
|
.br
|
|
\fR#include <locale>\fP
|
|
.br
|
|
\fR#include <sstream>\fP
|
|
.br
|
|
\fR#include <type_traits>\fP
|
|
.br
|
|
|
|
.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
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils::serialize::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::string \fBserif::utils::serialize::fingerprint\fP (std::string_view bytes)"
|
|
.br
|
|
.RI "Versioned content identity for accidental corruption and resource matching; not a cryptographic signature\&. "
|
|
.ti -1c
|
|
.RI "std::uint64_t \fBserif::utils::serialize::detail::value_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 \fBserif::utils::serialize::detail::encode_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 > \fBserif::utils::serialize::detail::decode_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 \fBserif::utils::serialize::detail::valid_path\fP (std::string_view path)"
|
|
.br
|
|
.RI "Restrict field names so path separators and line breaks cannot corrupt the ledger\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|