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	Offset
struct	String
class	Vector
class	vector_downward
struct	VectorIterator
class	VectorOfAny
Typedefs
typedef bool(*	FileExistsFunction )(const char *filename)
typedef bool(*	LoadFileFunction )(const char *filename, bool binary, std::string *dest)
Functions
std::string	AbsolutePath (const std::string &filepath)
template<typename T >
FLATBUFFERS_CONSTEXPR size_t	AlignOf ()
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)
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)
std::string	GetExtension (const std::string &filepath)
std::string	IntToStringHex (int i, int xdigits)
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	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)
LoadFileFunction	SetLoadFileFunction (LoadFileFunction load_file_function)
char &	string_back (std::string &value)
char	string_back (const std::string &value)
int64_t	StringToInt (const char *str, char **endptr=nullptr, int base=10)
uint64_t	StringToUInt (const char *str, char **endptr=nullptr, int base=10)
std::string	StripExtension (const std::string &filepath)
std::string	StripFileName (const std::string &filepath)
std::string	StripPath (const std::string &filepath)
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
static const char	kPathSeparator = '/'
static const char	kPathSeparatorWindows = '\\'
static const char *	PathSeparatorSet = "\\/"

---

Typedef Documentation

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

Definition at line 199 of file util.h.

typedef bool(* flatbuffers::LoadFileFunction)(const char *filename, bool binary, std::string *dest)

Definition at line 197 of file util.h.

---

Function Documentation

std::string flatbuffers::AbsolutePath

(

const std::string &

filepath

)

[inline]

Definition at line 322 of file util.h.

template<typename T >

FLATBUFFERS_CONSTEXPR size_t flatbuffers::AlignOf

(

)

Definition at line 41 of file flatbuffers.h.

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

Definition at line 280 of file util.h.

template<typename T , typename Alloc >

const T* flatbuffers::data

(

const std::vector< T, Alloc > &

v

)

Definition at line 709 of file flatbuffers.h.

template<typename T , typename Alloc >

T* flatbuffers::data

(

std::vector< T, Alloc > &

v

)

Definition at line 712 of file flatbuffers.h.

bool flatbuffers::DirExists

(

const char *

name

)

void flatbuffers::EndianCheck

(

)

[inline]

Definition at line 33 of file flatbuffers.h.

void flatbuffers::EnsureDirExists

(

const std::string &

filepath

)

[inline]

Definition at line 308 of file util.h.

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

Definition at line 443 of file util.h.

voffset_t flatbuffers::FieldIndexToOffset

(

voffset_t

field_id

)

[inline]

Definition at line 702 of file flatbuffers.h.

bool flatbuffers::FileExists

(

const char *

name

)

template<typename T >

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

Definition at line 124 of file util.h.

int flatbuffers::FromUTF8

(

const char **

in

)

[inline]

Definition at line 372 of file util.h.

std::string flatbuffers::GetExtension

(

const std::string &

filepath

)

[inline]

Definition at line 261 of file util.h.

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

Definition at line 160 of file util.h.

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

template<typename T >

std::string flatbuffers::NumToString

(

T

t

)

Definition at line 89 of file util.h.

template<>

std::string flatbuffers::NumToString< double >

(

double

t

)

[inline]

Definition at line 150 of file util.h.

template<>

std::string flatbuffers::NumToString< float >

(

float

t

)

[inline]

Definition at line 153 of file util.h.

template<>

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

(

signed char

t

)

[inline]

Definition at line 102 of file util.h.

template<>

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

(

unsigned char

t

)

[inline]

Definition at line 105 of file util.h.

std::string flatbuffers::PosixPath

(

const char *

path

)

[inline]

Definition at line 300 of file util.h.

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

Definition at line 223 of file util.h.

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

Definition at line 235 of file util.h.

FileExistsFunction flatbuffers::SetFileExistsFunction

(

FileExistsFunction

file_exists_function

)

LoadFileFunction flatbuffers::SetLoadFileFunction

(

LoadFileFunction

load_file_function

)

char& flatbuffers::string_back

(

std::string &

value

)

[inline]

Definition at line 41 of file stl_emulation.h.

char flatbuffers::string_back

(

const std::string &

value

)

[inline]

Definition at line 45 of file stl_emulation.h.

int64_t flatbuffers::StringToInt	(	const char *	str,
		char **	endptr = nullptr,
		int	base = 10
	)		[inline]

Definition at line 174 of file util.h.

uint64_t flatbuffers::StringToUInt	(	const char *	str,
		char **	endptr = nullptr,
		int	base = 10
	)		[inline]

Definition at line 186 of file util.h.

std::string flatbuffers::StripExtension

(

const std::string &

filepath

)

[inline]

Definition at line 255 of file util.h.

std::string flatbuffers::StripFileName

(

const std::string &

filepath

)

[inline]

Definition at line 273 of file util.h.

std::string flatbuffers::StripPath

(

const std::string &

filepath

)

[inline]

Definition at line 267 of file util.h.

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

Definition at line 344 of file util.h.

template<typename T >

T* flatbuffers::vector_data

(

std::vector< T > &

vector

)

[inline]

Definition at line 51 of file stl_emulation.h.

template<typename T >

const T* flatbuffers::vector_data

(

const std::vector< T > &

vector

)

[inline]

Definition at line 57 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 63 of file stl_emulation.h.

template<typename T , typename U >

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

(

Vector< Offset< U >> *

ptr

)

Definition at line 325 of file flatbuffers.h.

template<typename T , typename U >

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

(

const Vector< Offset< U >> *

ptr

)

Definition at line 331 of file flatbuffers.h.

template<typename T >

static size_t flatbuffers::VectorLength

(

const Vector< T > *

v

)

[inline, static]

Definition at line 339 of file 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 419 of file util.h.

---

Variable Documentation

const char flatbuffers::kPathSeparator = '/' [static]

Definition at line 250 of file util.h.

const char flatbuffers::kPathSeparatorWindows = '\\' [static]

Definition at line 251 of file util.h.

const char* flatbuffers::PathSeparatorSet = "\\/" [static]

Definition at line 252 of file util.h.