Awkward Array: include/awkward/builder/StringBuilder.h Source File

Loading...
Searching...
No Matches
StringBuilder.h
Go to the documentation of this file.
1// BSD 3-Clause License; see https://github.com/scikit-hep/awkward-1.0/blob/main/LICENSE
2
3#ifndef AWKWARD_STRINGBUILDER_H_
4#define AWKWARD_STRINGBUILDER_H_
5
6#include "awkward/common.h"
7#include "awkward/BuilderOptions.h"
8#include "awkward/GrowableBuffer.h"
9#include "awkward/builder/Builder.h"
10
11namespace awkward {
12
16 class LIBAWKWARD_EXPORT_SYMBOL StringBuilder: public Builder {
17 public:
24 static const BuilderPtr
25 fromempty(const BuilderOptions& options, const char* encoding);
26
38 StringBuilder(const BuilderOptions& options,
39 GrowableBuffer<int64_t> offsets,
40 GrowableBuffer<uint8_t> content,
41 const char* encoding);
42
46 const char*
47 encoding() const;
48
50 const std::string
51 classname() const override;
52
53 const std::string
54 to_buffers(BuffersContainer& container, int64_t& form_key_id) const override;
55
56 int64_t
57 length() const override;
58
59 void
60 clear() override;
61
65 bool
66 active() const override;
67
68 const BuilderPtr
69 null() override;
70
71 const BuilderPtr
72 boolean(bool x) override;
73
74 const BuilderPtr
75 integer(int64_t x) override;
76
77 const BuilderPtr
78 real(double x) override;
79
80 const BuilderPtr
81 complex(std::complex<double> x) override;
82
83 const BuilderPtr
84 datetime(int64_t x, const std::string& unit) override;
85
86 const BuilderPtr
87 timedelta(int64_t x, const std::string& unit) override;
88
89 const BuilderPtr
90 string(const char* x, int64_t length, const char* encoding) override;
91
92 const BuilderPtr
93 beginlist() override;
94
95 const BuilderPtr
96 endlist() override;
97
98 const BuilderPtr
99 begintuple(int64_t numfields) override;
100
101 const BuilderPtr
102 index(int64_t index) override;
103
104 const BuilderPtr
105 endtuple() override;
106
107 const BuilderPtr
108 beginrecord(const char* name, bool check) override;
109
110 void
111 field(const char* key, bool check) override;
112
113 const BuilderPtr
114 endrecord() override;
115
116 const BuilderOptions&
117 options() const { return options_; }
118
119 const GrowableBuffer<int64_t>& buffer() const { return offsets_; }
120
121 const GrowableBuffer<uint8_t>& content() const { return content_; }
122
123 private:
124 const BuilderOptions options_;
125 GrowableBuffer<int64_t> offsets_;
126 GrowableBuffer<uint8_t> content_;
127 const char* encoding_;
128 };
129
130}
131
132#endif // AWKWARD_STRINGBUILDER_H_
BuilderOptions.h
Builder.h
GrowableBuffer.h
awkward::BuffersContainer
Abstract class to represent the output of ak.to_buffers. In Python, this would be a dict of NumPy arr...
Definition: Builder.h:20
awkward::Builder
Abstract base class for nodes within an ArrayBuilder that cumulatively discover an array's type and f...
Definition: Builder.h:41
awkward::GrowableBuffer
Discontiguous, one-dimensional buffer (which consists of multiple contiguous, one-dimensional panels)...
Definition: GrowableBuffer.h:174
awkward::StringBuilder
Builder node that accumulates strings.
Definition: StringBuilder.h:16
awkward::StringBuilder::real
const BuilderPtr real(double x) override
Adds a real value x to the accumulated data.
awkward::StringBuilder::buffer
const GrowableBuffer< int64_t > & buffer() const
Definition: StringBuilder.h:119
awkward::StringBuilder::endlist
const BuilderPtr endlist() override
Ends a nested list.
awkward::StringBuilder::timedelta
const BuilderPtr timedelta(int64_t x, const std::string &unit) override
Adds a timedelta value x to the accumulated data.
awkward::StringBuilder::field
void field(const char *key, bool check) override
Sets the pointer to a given record field key; the next command will fill that slot.
awkward::StringBuilder::complex
const BuilderPtr complex(std::complex< double > x) override
Adds a complex value x to the accumulated data.
awkward::StringBuilder::index
const BuilderPtr index(int64_t index) override
Sets the pointer to a given tuple field index; the next command will fill that slot.
awkward::StringBuilder::content
const GrowableBuffer< uint8_t > & content() const
Definition: StringBuilder.h:121
awkward::StringBuilder::length
int64_t length() const override
Current length of the accumulated array.
awkward::StringBuilder::endrecord
const BuilderPtr endrecord() override
Ends a record.
awkward::StringBuilder::active
bool active() const override
If true, this node has started but has not finished a multi-step command (e.g. beginX ....
awkward::StringBuilder::string
const BuilderPtr string(const char *x, int64_t length, const char *encoding) override
Adds a string value x with a given length and encoding to the accumulated data.
awkward::StringBuilder::options
const BuilderOptions & options() const
Definition: StringBuilder.h:117
awkward::StringBuilder::integer
const BuilderPtr integer(int64_t x) override
Adds an integer value x to the accumulated data.
awkward::StringBuilder::datetime
const BuilderPtr datetime(int64_t x, const std::string &unit) override
Adds a datetime value x to the accumulated data.
awkward::StringBuilder::beginrecord
const BuilderPtr beginrecord(const char *name, bool check) override
Begins building a record with an optional name.
awkward::StringBuilder::StringBuilder
StringBuilder(const BuilderOptions &options, GrowableBuffer< int64_t > offsets, GrowableBuffer< uint8_t > content, const char *encoding)
Create a StringBuilder from a full set of parameters.
awkward::StringBuilder::null
const BuilderPtr null() override
Adds a null value to the accumulated data.
awkward::StringBuilder::to_buffers
const std::string to_buffers(BuffersContainer &container, int64_t &form_key_id) const override
Copy the current snapshot into the BuffersContainer and return a Form as a std::string (JSON).
awkward::StringBuilder::beginlist
const BuilderPtr beginlist() override
Begins building a nested list.
awkward::StringBuilder::boolean
const BuilderPtr boolean(bool x) override
Adds a boolean value x to the accumulated data.
awkward::StringBuilder::begintuple
const BuilderPtr begintuple(int64_t numfields) override
Begins building a tuple with a fixed number of fields.
awkward::StringBuilder::fromempty
static const BuilderPtr fromempty(const BuilderOptions &options, const char *encoding)
Create an empty StringBuilder.
awkward::StringBuilder::endtuple
const BuilderPtr endtuple() override
Ends a tuple.
awkward::StringBuilder::classname
const std::string classname() const override
User-friendly name of this class: "StringBuilder".
awkward::StringBuilder::clear
void clear() override
Removes all accumulated data without resetting the type knowledge.
awkward::StringBuilder::encoding
const char * encoding() const
If nullptr, the string is an unencoded bytestring; if "utf-8", it is encoded with variable-width UTF-...
common.h
LIBAWKWARD_EXPORT_SYMBOL
#define LIBAWKWARD_EXPORT_SYMBOL
Definition: common.h:45
awkward
Definition: BitMaskedArray.h:15
awkward::BuilderPtr
std::shared_ptr< Builder > BuilderPtr
Definition: ArrayBuilder.h:16
awkward::Options
Container for all configuration options needed by ArrayBuilder, GrowableBuffer, LayoutBuilder and the...
Definition: BuilderOptions.h:20