Outline ![]()
Files ![]()
loading...
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/openthread/openthread/src/core/common/heap_string.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
* Copyright (c) 2021, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* This file includes definitions for `Heap::String` (a heap allocated string).
*/
#ifndef HEAP_STRING_HPP_
#define HEAP_STRING_HPP_
#include "openthread-core-config.h"
#include "common/equatable.hpp"
#include "common/error.hpp"
#include "common/heap.hpp"
namespace ot {
namespace Heap {
/**
* Represents a heap allocated string.
*
* The buffer to store the string is allocated from heap and is managed by the `Heap::String` class itself, e.g., it may
* be reused and/or freed and reallocated when the string is set. The `Heap::String` destructor will always free the
* allocated buffer.
*/
class String : public Unequatable<String>
{
public:
/**
* Initializes the `String` as null (or empty).
*/
String(void)
: mStringBuffer(nullptr)
{
}
/**
* This is the move constructor for `String`.
*
* `String` is non-copyable (copy constructor is deleted) but move constructor is provided to allow it to to be
* used as return type (return by value) from functions/methods (which will then use move semantics).
*/
String(String &&aString)
: mStringBuffer(aString.mStringBuffer)
{
aString.mStringBuffer = nullptr;
}
/**
* This is the destructor for `HealString` object
*/
~String(void) { Free(); }
/**
* Indicates whether or not the `String` is null (i.e., it was never successfully set or it was
* freed).
*
* @retval TRUE The `String` is null.
* @retval FALSE The `String` is not null.
*/
bool IsNull(void) const { return (mStringBuffer == nullptr); }
/**
* Returns the `String` as a C string.
*
* @returns A pointer to C string buffer or `nullptr` if the `String` is null (never set or freed).
*/
const char *AsCString(void) const { return mStringBuffer; }
/**
* Sets the string from a given C string.
*
* @param[in] aCString A pointer to c string buffer. Can be `nullptr` which then frees the `String`.
*
* @retval kErrorNone Successfully set the string.
* @retval kErrorNoBufs Failed to allocate buffer for string.
*/
Error Set(const char *aCString);
/**
* Sets the string from another `String`.
*
* @param[in] aString The other `String` to set from.
*
* @retval kErrorNone Successfully set the string.
* @retval kErrorNoBufs Failed to allocate buffer for string.
*/
Error Set(const String &aString) { return Set(aString.AsCString()); }
/**
* Sets the string from another `String`.
*
* @param[in] aString The other `String` to set from (rvalue reference using move semantics).
*
* @retval kErrorNone Successfully set the string.
* @retval kErrorNoBufs Failed to allocate buffer for string.
*/
Error Set(String &&aString);
/**
* Frees any buffer allocated by the `String`.
*
* The `String` destructor will automatically call `Free()`. This method allows caller to free buffer
* explicitly.
*/
void Free(void);
/**
* Overloads operator `==` to evaluate whether or not the `String` is equal to a given C string.
*
* @param[in] aCString A C string to compare with. Can be `nullptr` which then checks if `String` is null.
*
* @retval TRUE If the two strings are equal.
* @retval FALSE If the two strings are not equal.
*/
bool operator==(const char *aCString) const;
/**
* Overloads operator `!=` to evaluate whether or not the `String` is unequal to a given C string.
*
* @param[in] aCString A C string to compare with. Can be `nullptr` which then checks if `String` is not null.
*
* @retval TRUE If the two strings are not equal.
* @retval FALSE If the two strings are equal.
*/
bool operator!=(const char *aCString) const { return !(*this == aCString); }
/**
* Overloads operator `==` to evaluate whether or not two `String` are equal.
*
* @param[in] aString The other string to compare with.
*
* @retval TRUE If the two strings are equal.
* @retval FALSE If the two strings are not equal.
*/
bool operator==(const String &aString) const { return (*this == aString.AsCString()); }
String(const String &) = delete;
String &operator=(const String &) = delete;
private:
char *mStringBuffer;
};
} // namespace Heap
} // namespace ot
#endif // HEAP_STRING_HPP_
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.