flatbuffers Namespace Reference

Classes
class	Allocator
class	DefaultAllocator
class	DetachedBuffer
class	FlatBufferBuilder
	Helper class to hold data needed in creation of a FlatBuffer. To serialize data, you typically call one of the `Create*()` functions in the generated code, which in turn call a sequence of `StartTable`/ `PushElement`/`AddElement`/`EndTable`, or the builtin `CreateString`/ `CreateVector` functions. Do this is depth-first order to build up a tree to the root. `Finish()` wraps up the buffer ready for transport. More...
struct	IndirectHelper
struct	IndirectHelper< const T * >
struct	IndirectHelper< Offset< T > >
struct	is_floating_point
struct	is_same
struct	is_scalar
struct	is_unsigned
struct	make_unsigned
class	numeric_limits
struct	Offset
struct	String
class	unique_ptr
class	Vector
class	vector_downward
struct	VectorIterator
class	VectorOfAny
struct	VectorReverseIterator
Typedefs
typedef bool(*	FileExistsFunction )(const char *filename)
Functions
	__supress_ubsan__ ("float-cast-overflow") inline void strtoval_impl(float *val
std::string	AbsolutePath (const std::string &filepath)
template<typename T >
FLATBUFFERS_CONSTEXPR size_t	AlignOf ()
uint8_t *	Allocate (Allocator *allocator, size_t size)
template<typename T >
bool	check_in_range (T x, T a, T b)
std::string	ConCatPathFileName (const std::string &path, const std::string &filename)
template<typename T , typename Alloc >
const T *	data (const std::vector< T, Alloc > &v)
template<typename T , typename Alloc >
T *	data (std::vector< T, Alloc > &v)
void	Deallocate (Allocator *allocator, uint8_t *p, size_t size)
bool	DirExists (const char *name)
void	EndianCheck ()
void	EnsureDirExists (const std::string &filepath)
bool	EscapeString (const char *s, size_t length, std::string *_text, bool allow_non_utf8, bool natural_utf8)
voffset_t	FieldIndexToOffset (voffset_t field_id)
bool	FileExists (const char *name)
template<typename T >
std::string	FloatToString (T t, int precision)
int	FromUTF8 (const char **in)
static const char *	GetCstring (const String *str)
std::string	GetExtension (const std::string &filepath)
static std::string	GetString (const String *str)
std::string	IntToStringHex (int i, int xdigits)
bool	is_alnum (char c)
bool	is_alpha (char c)
bool	is_alpha_char (char c, char alpha)
bool	is_digit (char c)
bool	is_xdigit (char c)
template<typename T >
bool	IsTheSameAs (T e, T def)
bool	LoadFile (const char *name, bool binary, std::string *buf)
template<typename T >
std::string	NumToString (T t)
template<>
std::string	NumToString< double > (double t)
template<>
std::string	NumToString< float > (float t)
template<>
std::string	NumToString< signed char > (signed char t)
template<>
std::string	NumToString< unsigned char > (unsigned char t)
std::string	PosixPath (const char *path)
bool	ReadEnvironmentVariable (const char *var_name, std::string *_value=nullptr)
uint8_t *	ReallocateDownward (Allocator *allocator, uint8_t *old_p, size_t old_size, size_t new_size, size_t in_use_back, size_t in_use_front)
std::string	RemoveStringQuotes (const std::string &s)
bool	SaveFile (const char *name, const char *buf, size_t len, bool binary)
bool	SaveFile (const char *name, const std::string &buf, bool binary)
FileExistsFunction	SetFileExistsFunction (FileExistsFunction file_exists_function)
bool	SetGlobalTestLocale (const char *locale_name, std::string *_value=nullptr)
LoadFileFunction	SetLoadFileFunction (LoadFileFunction load_file_function)
char &	string_back (std::string &value)
char	string_back (const std::string &value)
static bool	StringLessThan (const char *a_data, uoffset_t a_size, const char *b_data, uoffset_t b_size)
std::string	StripExtension (const std::string &filepath)
std::string	StripFileName (const std::string &filepath)
std::string	StripPath (const std::string &filepath)
void	strtoval_impl (int64_t *val, const char *str, char **endptr, int base)
void	strtoval_impl (uint64_t *val, const char *str, char **endptr, int base)
void	strtoval_impl (double *val, const char *str, char **endptr)
int	ToUTF8 (uint32_t ucc, std::string *out)
template<typename T >
T *	vector_data (std::vector< T > &vector)
template<typename T >
const T *	vector_data (const std::vector< T > &vector)
template<typename T , typename V >
void	vector_emplace_back (std::vector< T > *vector, V &&data)
template<typename T , typename U >
Vector< Offset< T > > *	VectorCast (Vector< Offset< U >> *ptr)
template<typename T , typename U >
const Vector< Offset< T > > *	VectorCast (const Vector< Offset< U >> *ptr)
template<typename T >
static size_t	VectorLength (const Vector< T > *v)
std::string	WordWrap (const std::string in, size_t max_length, const std::string wrapped_line_prefix, const std::string wrapped_line_suffix)
Variables
FLATBUFFERS_CONSTEXPR char	kPathSeparator = '/'
const char *	str

---

Typedef Documentation

typedef bool(* flatbuffers::FileExistsFunction)(const char *filename)

Definition at line 392 of file util.h.

---

Function Documentation

flatbuffers::__supress_ubsan__

(

"float-cast-overflow"

)

std::string flatbuffers::AbsolutePath

(

const std::string &

filepath

)

template<typename T >

FLATBUFFERS_CONSTEXPR size_t flatbuffers::AlignOf

(

)

Definition at line 59 of file 3rdparty/flatbuffers/flatbuffers.h.

uint8_t * flatbuffers::Allocate	(	Allocator *	allocator,
		size_t	size
	)		[inline]

Definition at line 495 of file 3rdparty/flatbuffers/flatbuffers.h.

template<typename T >

bool flatbuffers::check_in_range	(	T	x,
		T	a,
		T	b
	)		[inline]

Definition at line 40 of file util.h.

std::string flatbuffers::ConCatPathFileName	(	const std::string &	path,
		const std::string &	filename
	)

template<typename T , typename Alloc >

const T * flatbuffers::data

(

const std::vector< T, Alloc > &

v

)

Definition at line 892 of file 3rdparty/flatbuffers/flatbuffers.h.

template<typename T , typename Alloc >

T * flatbuffers::data

(

std::vector< T, Alloc > &

v

)

Definition at line 895 of file 3rdparty/flatbuffers/flatbuffers.h.

void flatbuffers::Deallocate	(	Allocator *	allocator,
		uint8_t *	p,
		size_t	size
	)		[inline]

Definition at line 500 of file 3rdparty/flatbuffers/flatbuffers.h.

bool flatbuffers::DirExists

(

const char *

name

)

void flatbuffers::EndianCheck

(

)

[inline]

Definition at line 51 of file 3rdparty/flatbuffers/flatbuffers.h.

void flatbuffers::EnsureDirExists

(

const std::string &

filepath

)

bool flatbuffers::EscapeString	(	const char *	s,
		size_t	length,
		std::string *	_text,
		bool	allow_non_utf8,
		bool	natural_utf8
	)		[inline]

Definition at line 566 of file util.h.

voffset_t flatbuffers::FieldIndexToOffset

(

voffset_t

field_id

)

[inline]

Definition at line 885 of file 3rdparty/flatbuffers/flatbuffers.h.

bool flatbuffers::FileExists

(

const char *

name

)

template<typename T >

std::string flatbuffers::FloatToString	(	T	t,
		int	precision
	)

Definition at line 149 of file util.h.

int flatbuffers::FromUTF8

(

const char **

in

)

[inline]

Definition at line 494 of file util.h.

static const char * flatbuffers::GetCstring

(

const String *

str

)

[inline, static]

Definition at line 429 of file 3rdparty/flatbuffers/flatbuffers.h.

std::string flatbuffers::GetExtension

(

const std::string &

filepath

)

static std::string flatbuffers::GetString

(

const String *

str

)

[inline, static]

Definition at line 423 of file 3rdparty/flatbuffers/flatbuffers.h.

std::string flatbuffers::IntToStringHex	(	int	i,
		int	xdigits
	)		[inline]

Definition at line 186 of file util.h.

bool flatbuffers::is_alnum

(

char

c

)

[inline]

Definition at line 73 of file util.h.

bool flatbuffers::is_alpha

(

char

c

)

[inline]

Definition at line 48 of file util.h.

bool flatbuffers::is_alpha_char	(	char	c,
		char	alpha
	)		[inline]

Definition at line 54 of file util.h.

bool flatbuffers::is_digit

(

char

c

)

[inline]

Definition at line 65 of file util.h.

bool flatbuffers::is_xdigit

(

char

c

)

[inline]

Definition at line 67 of file util.h.

template<typename T >

bool flatbuffers::IsTheSameAs	(	T	e,
		T	def
	)		[inline]

Definition at line 28 of file 3rdparty/flatbuffers/flatbuffers.h.

bool flatbuffers::LoadFile	(	const char *	name,
		bool	binary,
		std::string *	buf
	)

template<typename T >

std::string flatbuffers::NumToString

(

T

t

)

Definition at line 113 of file util.h.

template<>

std::string flatbuffers::NumToString< double >

(

double

t

)

[inline]

Definition at line 176 of file util.h.

template<>

std::string flatbuffers::NumToString< float >

(

float

t

)

[inline]

Definition at line 179 of file util.h.

template<>

std::string flatbuffers::NumToString< signed char >

(

signed char

t

)

[inline]

Definition at line 127 of file util.h.

template<>

std::string flatbuffers::NumToString< unsigned char >

(

unsigned char

t

)

[inline]

Definition at line 130 of file util.h.

std::string flatbuffers::PosixPath

(

const char *

path

)

bool flatbuffers::ReadEnvironmentVariable	(	const char *	var_name,
		std::string *	_value = nullptr
	)

uint8_t * flatbuffers::ReallocateDownward	(	Allocator *	allocator,
		uint8_t *	old_p,
		size_t	old_size,
		size_t	new_size,
		size_t	in_use_back,
		size_t	in_use_front
	)		[inline]

Definition at line 505 of file 3rdparty/flatbuffers/flatbuffers.h.

std::string flatbuffers::RemoveStringQuotes

(

const std::string &

s

)

bool flatbuffers::SaveFile	(	const char *	name,
		const char *	buf,
		size_t	len,
		bool	binary
	)

bool flatbuffers::SaveFile	(	const char *	name,
		const std::string &	buf,
		bool	binary
	)		[inline]

Definition at line 422 of file util.h.

FileExistsFunction flatbuffers::SetFileExistsFunction

(

FileExistsFunction

file_exists_function

)

bool flatbuffers::SetGlobalTestLocale	(	const char *	locale_name,
		std::string *	_value = nullptr
	)

LoadFileFunction flatbuffers::SetLoadFileFunction

(

LoadFileFunction

load_file_function

)

char& flatbuffers::string_back

(

std::string &

value

)

[inline]

Definition at line 51 of file stl_emulation.h.

char flatbuffers::string_back

(

const std::string &

value

)

[inline]

Definition at line 55 of file stl_emulation.h.

static bool flatbuffers::StringLessThan	(	const char *	a_data,
		uoffset_t	a_size,
		const char *	b_data,
		uoffset_t	b_size
	)		[inline, static]

Definition at line 398 of file 3rdparty/flatbuffers/flatbuffers.h.

std::string flatbuffers::StripExtension

(

const std::string &

filepath

)

std::string flatbuffers::StripFileName

(

const std::string &

filepath

)

std::string flatbuffers::StripPath

(

const std::string &

filepath

)

void flatbuffers::strtoval_impl	(	int64_t *	val,
		const char *	str,
		char **	endptr,
		int	base
	)		[inline]

Definition at line 241 of file util.h.

void flatbuffers::strtoval_impl	(	uint64_t *	val,
		const char *	str,
		char **	endptr,
		int	base
	)		[inline]

Definition at line 246 of file util.h.

void flatbuffers::strtoval_impl	(	double *	val,
		const char *	str,
		char **	endptr
	)		[inline]

Definition at line 251 of file util.h.

int flatbuffers::ToUTF8	(	uint32_t	ucc,
		std::string *	out
	)		[inline]

Definition at line 466 of file util.h.

template<typename T >

T* flatbuffers::vector_data

(

std::vector< T > &

vector

)

[inline]

Definition at line 61 of file stl_emulation.h.

template<typename T >

const T* flatbuffers::vector_data

(

const std::vector< T > &

vector

)

[inline]

Definition at line 67 of file stl_emulation.h.

template<typename T , typename V >

void flatbuffers::vector_emplace_back	(	std::vector< T > *	vector,
		V &&	data
	)		[inline]

Definition at line 73 of file stl_emulation.h.

template<typename T , typename U >

Vector< Offset< T > > * flatbuffers::VectorCast

(

Vector< Offset< U >> *

ptr

)

Definition at line 378 of file 3rdparty/flatbuffers/flatbuffers.h.

template<typename T , typename U >

const Vector< Offset< T > > * flatbuffers::VectorCast

(

const Vector< Offset< U >> *

ptr

)

Definition at line 384 of file 3rdparty/flatbuffers/flatbuffers.h.

template<typename T >

static size_t flatbuffers::VectorLength

(

const Vector< T > *

v

)

[inline, static]

Definition at line 392 of file 3rdparty/flatbuffers/flatbuffers.h.

std::string flatbuffers::WordWrap	(	const std::string	in,
		size_t	max_length,
		const std::string	wrapped_line_prefix,
		const std::string	wrapped_line_suffix
	)		[inline]

Definition at line 542 of file util.h.

---

Variable Documentation

FLATBUFFERS_CONSTEXPR char flatbuffers::kPathSeparator = '/'

Definition at line 432 of file util.h.

const char* flatbuffers::str

Definition at line 257 of file util.h.