Helper for building an array of strings with a similar API as a Numpy builder. More...

#include <LayoutBuilder.h>

Inheritance diagram for String< PRIMITIVE >:

Public Member Functions
	String ()

void	append (const std::string &value)

Public Member Functions inherited from ListOffset< PRIMITIVE, Numpy< uint8_t > >
	ListOffset ()
	Creates a new ListOffset layout builder by allocating a new `offset` buffer, using `AWKWARD_LAYOUTBUILDER_DEFAULT_OPTIONS` for initializing the buffer.

	ListOffset (const awkward::BuilderOptions &options)
	Creates a new ListOffset layout builder by allocating a new `offset` buffer, taking `options` from `BuilderOptions` for initializing the buffer.

Numpy< uint8_t > &	content () noexcept
	Returns the reference to the builder content.

Numpy< uint8_t > &	begin_list () noexcept
	Begins a list and returns the reference to the builder content.

void	end_list () noexcept
	Ends a list and appends the current length of the list contents in the `offsets` buffer.

const std::string &	parameters () const noexcept
	Parameters for the builder form.

void	set_parameters (std::string parameter) noexcept
	Sets the form parameters.

void	set_id (size_t &id) noexcept
	Assigns a unique ID to each node.

void	clear () noexcept
	Discards the accumulated offsets and clears the builder content.

size_t	length () const noexcept
	Current length of the content.

bool	is_valid (std::string &error) const noexcept
	Checks for validity and consistency.

void	buffer_nbytes (std::map< std::string, size_t > &names_nbytes) const noexcept
	Retrieves the names and sizes (in bytes) of the buffers used in the builder and its contents.

void	to_buffers (std::map< std::string, void * > &buffers) const noexcept
	Copies and concatenates all the accumulated data in each of the buffers of the builder and its contents to user-defined pointers.

void	to_buffer (void buffer, const char name) const noexcept
	Copies and concatenates the accumulated data in the builder buffer to a user-defined pointer if the given node name matches with the node associated with the builder; otherwise, it searches the builder contents to locate a matching node.

void	to_char_buffers (std::map< std::string, uint8_t * > &buffers) const noexcept
	Copies and concatenates all the accumulated data in the builder to a map of user-allocated buffers.

std::string	form () const noexcept
	Generates a unique description of the builder and its contents in the form of a JSON-like string.

Detailed Description

template<class PRIMITIVE>
class awkward::LayoutBuilder::String< PRIMITIVE >

Helper for building an array of strings with a similar API as a Numpy builder.

Constructor & Destructor Documentation

◆ String()

template<class PRIMITIVE >

String ( )

inline

Member Function Documentation

◆ append()