Coldwave Documentation

Appearance

class flake::Property ​

#include <FlakeTypes.h>

Public Functions ​

Name
[uint32_t]tag() const
[bool]isMeta() const
[void]setNull()
[void]setError([tt_int8_t] err)
[PropValue]data() const
template <typenameT >
[void]		setData([T] data)
template <typenameT >
std::optional< [T] >		value() const
Property([const][uint32_t] _tag)
Property()
Property([const]Property & v)
[void]makeReadOnly() const
~Property()
[void]setDeallocSelf()
Property &operator=([const]Property & other)
[void]copyFrom([const]Property & other)
[bool]serializeTo([uint8_t] * buf, [uint16_t] & offset, [uint16_t] bufSize, [uint16_t] * consumedBytes =[nullptr]) const
[bool]deserializeFrom([const][uint8_t] * buf, [uint16_t] & offset, [uint16_t] bufSize, [uint16_t] * consumedBytes =[nullptr])
[bool]isErrorValue() const
[uint16_t]getSerializedSize() const
[char] *toString() const

Friends ​

Name
[bool]operator==([const]Property & lhs, [const]Property & rhs)
[bool]operator!=([const]Property & lhs, [const]Property & rhs)

Public Functions Documentation ​

function tag ​

cpp
inline uint32_t tag() const

function isMeta ​

cpp
inline bool isMeta() const

function setNull ​

cpp
inline void setNull()

function setError ​

cpp
inline void setError(
    tt_int8_t err
)

function data ​

cpp
inline PropValue data() const

function setData ​

cpp
template <typenameT >
inline void setData(
    T data
)

function value ​

cpp
template <typenameT >
inline std::optional< T > value() const

function Property ​

cpp
inline explicit Property(
    constuint32_t _tag
)

function Property ​

cpp
inline Property()

function Property ​

cpp
inline Property(
    constProperty & v
)

function makeReadOnly ​

cpp
inline void makeReadOnly() const

function ~Property ​

cpp
inline ~Property()

function setDeallocSelf ​

cpp
inline void setDeallocSelf()

function operator= ​

cpp
inline Property & operator=(
    constProperty & other
)

function copyFrom ​

cpp
inline void copyFrom(
    constProperty & other
)

function serializeTo ​

cpp
inline bool serializeTo(
    uint8_t * buf,
    uint16_t & offset,
    uint16_t bufSize,
    uint16_t * consumedBytes =nullptr
) const

function deserializeFrom ​

cpp
inline bool deserializeFrom(
    constuint8_t * buf,
    uint16_t & offset,
    uint16_t bufSize,
    uint16_t * consumedBytes =nullptr
)

function isErrorValue ​

cpp
inline bool isErrorValue() const

function getSerializedSize ​

cpp
inline uint16_t getSerializedSize() const

function toString ​

cpp
inline char * toString() const

Friends ​

friend operator== ​

cpp
friend bool operator==(
    constProperty & lhs,

    constProperty & rhs
);

friend operator!= ​

cpp
friend bool operator!=(
    constProperty & lhs,

    constProperty & rhs
);