StormByte 3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Detail::Codec< Safe::WString > Struct Reference

StormByte::Detail::Codec specialization for StormByte::Safe::WString. More...

#include <StormByte/serializable.hxx>

Static Public Member Functions

static ByteSize Size (const Safe::WString &data) noexcept
 Serialized size of data.
static Safe::Binary Write (const Safe::WString &data) noexcept
 Encodes data.
static Expected< Safe::WString, DeserializeError > Read (std::span< const std::byte > data) noexcept
 Decodes a StormByte::Safe::WString from the start of data.

Detailed Description

StormByte::Detail::Codec specialization for StormByte::Safe::WString.

Same UTF-8 wire as std::wstring, preserving embedded NUL characters. A null StormByte::Safe::WString is written as an empty payload. Decode always yields a non-null buffer (L"" when the payload is empty).

Member Function Documentation

◆ Read()

Expected< Safe::WString, DeserializeError > StormByte::Detail::Codec< Safe::WString >::Read ( std::span< const std::byte > data)
staticnoexcept

Decodes a StormByte::Safe::WString from the start of data.

Parameters
dataInput span.
Returns
Value, or StormByte::DeserializeError.

◆ Size()

ByteSize StormByte::Detail::Codec< Safe::WString >::Size ( const Safe::WString & data)
staticnoexcept

Serialized size of data.

Parameters
dataValue to measure.
Returns
Size in bytes as ByteSize.

◆ Write()

Safe::Binary StormByte::Detail::Codec< Safe::WString >::Write ( const Safe::WString & data)
staticnoexcept

Encodes data.

Parameters
dataValue to encode.
Returns
Blob owned by Base.

The documentation for this struct was generated from the following file: