Empty Class Reference

Builds an EmptyArray which has no content in it. It is used whenever an array's type is not known because it is empty. More...

#include <LayoutBuilder.h>

Public Member Functions
	Empty ()
	Creates a new Empty layout builder.
void	set_id (size_t &) noexcept
void	clear () noexcept
size_t	length () const noexcept
	Current length of the content.
bool	is_valid (std::string &) const noexcept
	Checks for validity and consistency.
void	buffer_nbytes (std::map< std::string, size_t > &) const noexcept
void	to_buffers (std::map< std::string, void * > &) const noexcept
void	to_buffer (void *, const char *) const noexcept
void	to_char_buffers (std::map< std::string, uint8_t * > &) 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

Builds an EmptyArray which has no content in it. It is used whenever an array's type is not known because it is empty.

Constructor & Destructor Documentation

Empty()

Empty ( )

inline

Creates a new Empty layout builder.

Member Function Documentation

buffer_nbytes()

void buffer_nbytes ( std::map< std::string, size_t > & ) const

inlinenoexcept

clear()

void clear ( )

inlinenoexcept

form()

std::string form ( ) const

inlinenoexcept

Generates a unique description of the builder and its contents in the form of a JSON-like string.

is_valid()

bool is_valid ( std::string & ) const

inlinenoexcept

Checks for validity and consistency.

length()

size_t length ( ) const

inlinenoexcept

Current length of the content.

set_id()

void set_id ( size_t & )

inlinenoexcept

to_buffer()

void to_buffer ( void * , const char *  ) const

inlinenoexcept

to_buffers()

void to_buffers ( std::map< std::string, void * > & ) const

inlinenoexcept

to_char_buffers()

void to_char_buffers ( std::map< std::string, uint8_t * > & ) const

inlinenoexcept

Copies and concatenates all the accumulated data in the builder to a map of user-allocated buffers.

The map keys and the buffer sizes are obtained from buffer_nbytes

---

The documentation for this class was generated from the following file:

• /home/runner/work/awkward/awkward/awkward-cpp/header-only/layout-builder/awkward/LayoutBuilder.h