ot::Heap::Data class

Represents a heap allocated data.

Syntax

Show:

Summary

Declaration

from heap_data.hpp:49

class Data { public: Data(void) { mData.Init(nullptr, 0); } Data(Data &&aData) { TakeFrom(aData); } ~Data(void) { Free(); } bool IsNull(void) const { return (mData.GetBytes() == nullptr); } const uint8_t *GetBytes(void) const { return mData.GetBytes(); } uint16_t GetLength(void) const { return mData.GetLength(); } Error SetFrom(const uint8_t *aBuffer, uint16_t aLength); Error SetFrom(const Message &aMessage); Error SetFrom(const Message &aMessage, uint16_t aOffset, uint16_t aLength); void SetFrom(Data &&aData); Error CopyBytesTo(Message &aMessage) const { return aMessage.AppendBytes(mData.GetBytes(), mData.GetLength()); } void CopyBytesTo(uint8_t *aBuffer) const { return mData.CopyBytesTo(aBuffer); } bool Matches(const uint8_t *aBuffer, uint16_t aLength) const; bool operator==(const Data &aOtherData) const { return mData == aOtherData.mData; } void Free(void); Data(const Data &) = delete; Data &operator=(const Data &) = delete; private: Error UpdateBuffer(uint16_t aNewLength); void TakeFrom(Data &aData); MutableData<kWithUint16Length> mData; };

Fields

Field

Declared as

ot::Heap::Data::mData

MutableData<kWithUint16Length>

Methods

IsNull() const

Indicates whether or not the `Heap::Data` is null (i.e., it was never successfully set or it was freed).

GetBytes() const

Returns a pointer to the `Heap::Data` bytes buffer.

GetLength() const

Returns the `Heap::Data` length.

SetFrom()

Sets the `Heap::Data` from the content of a given buffer.

SetFrom()

Sets the `Heap::Data` from the content of a given buffer.

SetFrom()

Sets the `Heap::Data` from the content of a given buffer.

SetFrom()

Sets the `Heap::Data` from the content of a given buffer.

CopyBytesTo() const

Appends the bytes from `Heap::Data` to a given message.

CopyBytesTo() const

Appends the bytes from `Heap::Data` to a given message.

Matches() const

Compares the `Data` content with the bytes from a given buffer.

operator() const

Overloads operator `==` to compare the `Data` content with the content from another one.

Free()

Frees any buffer allocated by the `Heap::Data`. The `Heap::Data` destructor will automatically call `Free()`. This method allows caller to free the buffer explicitly.