-
Notifications
You must be signed in to change notification settings - Fork 25
Expand file tree
/
Copy pathstringfield.h
More file actions
153 lines (128 loc) · 4.97 KB
/
stringfield.h
File metadata and controls
153 lines (128 loc) · 4.97 KB
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
/*
* BSD 2-Clause License
*
* Copyright (c) 2021-2024, Hewlett Packard Enterprise
* 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.
*
* 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.
*/
#ifndef SMARTREDIS_STRINGFIELD_H
#define SMARTREDIS_STRINGFIELD_H
#include "metadatafield.h"
#include "metadatabuffer.h"
///@file
namespace SmartRedis {
/*!
* \brief The StringField class implements
* MetadataField class methods needed for
* storage and transfer of metadata string
* fields.
*/
class StringField : public MetadataField {
public:
/*!
* \brief StringField constructor
* \param name The name used to reference the string field
*/
StringField(const std::string& name);
/*!
* \brief StringField constructor with initial values to be copied
* \param name The name used to reference the string field
* \param vals An inital vector of values to populate the StringField
*/
StringField(const std::string& name,
const std::vector<std::string>& vals);
/*!
* \brief StringField constructor with initial values to be moved
* \param name The name used to reference the string field
* \param vals An inital vector of values to populate the StringField.
* Move semantics will be used.
*/
StringField(const std::string& name,
std::vector<std::string>&& vals);
/*!
* \brief Default StringField copy constructor
* \param string_field The string field to be copied.
*/
StringField(const StringField& string_field) = default;
/*!
* \brief Default StringField move constructor
* \param string_field The string field to be moved for construction.
*/
StringField(StringField&& string_field) = default;
/*!
* \brief Default StringField copy assignment operator
* \param string_field The string field to be copied.
*/
StringField& operator=(const StringField& string_field)
= default;
/*!
* \brief Default StringField move assignment operator
* \param string_field The string field to be moved.
*/
StringField& operator=(StringField&& string_field)
= default;
/*!
* \brief Default StringField destructor
*/
virtual ~StringField() = default;
/*!
* \brief Serialize the StringField for
* transmission and storage.
* \returns A string of the serialized field
*/
virtual std::string serialize();
/*!
* \brief Add a string to the field
* \param value A c-ptr to the value to append
*/
void append(const std::string& value);
/*!
* \brief Retrieve the number of values in the field
* \returns The number of values
*/
virtual size_t size() const;
/*!
* \brief Clear the values in the field
*/
virtual void clear();
/*!
* \brief Returns a copy of the underlying field string
* values.
* \returns std::vector<std::string> of string values
*/
std::vector<std::string> values();
/*!
* \brief Returns a constant reference to the internal
* std::vector<std::string> object.
* \returns const reference to std::vector<std::string>
* of string values
*/
const std::vector<std::string>& immutable_values();
private:
/*!
* \brief The ScalarField values
*/
std::vector<std::string> _vals;
};
} // namespace SmartRedis
#endif // SMARTREDIS_STRINGFIELD_H