66 lines
1.8 KiB
Groff
66 lines
1.8 KiB
Groff
|
.TH "src/lib/serif/utils/serialize/format.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
src/lib/serif/utils/serialize/format.hpp
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fR#include <string>\fP
|
||
|
|
.br
|
||
|
|
\fR#include <string_view>\fP
|
||
|
|
.br
|
||
|
|
\fR#include 'serif/utils/serialize/archive\&.hpp'\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::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 "\fBNode\fP \fBserif::utils::serialize::detail::provenance\fP (const \fBWriteOptions\fP &options)"
|
||
|
|
.br
|
||
|
|
.RI "Capture provenance once at the beginning of a write\&. "
|
||
|
|
.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
|
||
|
|
.SS "Variables"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "constexpr std::uint64_t \fBserif::utils::serialize::detail::header_bytes\fP = 512"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|