CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::CBOR::Map Struct Reference

Represents a CBOR map. More...

#include <CeresEngine/Foundation/CBOR.hpp>

Public Member Functions

bool isIndeterminate () const noexcept
 Determines if the array is indeterminate.
 

Public Attributes

UInt64 size = ~0u
 The number of key-pair items in the map.
 

Detailed Description

Represents a CBOR map.

In CBOR, maps can either be determinate, meaning they have a known size, or indeterminate, meaning their size is not known at the time the encoding starts.

When size value is set other than ~0u, it indicates a definite-sized map. In this case, exactly 2 * size values must be written following the map. The first value is the key, where as the second represents the value for key.

If size equals ~0u, then the map is indeterminate, and the number of items is not known when encoding starts. In this case, an arbitrary number of elements, including 0, can be encoded, but values must be always encoded in pairs of key and value. To indicate the end of the map a Break must be encoded.

Member Function Documentation

◆ isIndeterminate()

bool CeresEngine::CBOR::Map::isIndeterminate ( ) const
inlinenoexcept

Determines if the array is indeterminate.

Member Data Documentation

◆ size

UInt64 CeresEngine::CBOR::Map::size = ~0u

The number of key-pair items in the map.


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