flatbuffers.h File Reference

#include <algorithm>
#include "flatbuffers/array.h"
#include "flatbuffers/base.h"
#include "flatbuffers/buffer.h"
#include "flatbuffers/buffer_ref.h"
#include "flatbuffers/detached_buffer.h"
#include "flatbuffers/flatbuffer_builder.h"
#include "flatbuffers/stl_emulation.h"
#include "flatbuffers/string.h"
#include "flatbuffers/struct.h"
#include "flatbuffers/table.h"
#include "flatbuffers/vector.h"
#include "flatbuffers/vector_downward.h"
#include "flatbuffers/verifier.h"

Go to the source code of this file.

Data Structures
struct	flatbuffers::NativeTable
struct	flatbuffers::TypeCode
struct	flatbuffers::TypeTable

Namespaces
namespace	flatbuffers

Macros
#define	FLATBUFFERS_GEN_ELEMENTARY_TYPES(ET)
#define	FLATBUFFERS_ET(E)   E,
#define	FLATBUFFERS_ET(E)   #E,
#define	FLATBUFFERS_DEFINE_BITMASK_OPERATORS(E, T)

Typedefs
typedef uint64_t	flatbuffers::hash_value_t
	Function types to be used with resolving hashes into objects and back again. The resolver gets a pointer to a field inside an object API object that is of the type specified in the schema using the attribute cpp_type (it is thus important whatever you write to this address matches that type). The value of this field is initially null, so you may choose to implement a delayed binding lookup using this function if you wish. The resolver does the opposite lookup, for when the object is being serialized again.
typedef std::function< void(void **pointer_adr, hash_value_t hash)>	flatbuffers::resolver_function_t
typedef std::function< hash_value_t(void *pointer)>	flatbuffers::rehasher_function_t
typedef const TypeTable *(*	flatbuffers::TypeFunction) ()

Enumerations
enum	flatbuffers::SequenceType { flatbuffers::ST_TABLE , flatbuffers::ST_STRUCT , flatbuffers::ST_UNION , flatbuffers::ST_ENUM }
enum	flatbuffers::ElementaryType

Functions
const uint8_t *	flatbuffers::GetBufferStartFromRootPointer (const void *root)
	This can compute the start of a FlatBuffer from a root pointer, i.e. it is the opposite transformation of GetRoot(). This may be useful if you want to pass on a root and have the recipient delete the buffer afterwards.
template<typename SizeT = uoffset_t>
SizeT	flatbuffers::GetPrefixedSize (const uint8_t *buf)
	This return the prefixed size of a FlatBuffer.
template<typename SizeT = uoffset_t>
SizeT	flatbuffers::GetSizePrefixedBufferLength (const uint8_t *const buf)
template<typename T >
bool	flatbuffers::IsFieldPresent (const T *table, typename T::FlatBuffersVTableOffset field)
int	flatbuffers::LookupEnum (const char **names, const char *name)
const char *const *	flatbuffers::ElementaryTypeNames ()
const char *	flatbuffers::flatbuffers_version_string ()

Macro Definition Documentation

FLATBUFFERS_DEFINE_BITMASK_OPERATORS

#define FLATBUFFERS_DEFINE_BITMASK_OPERATORS	(		E,
			T
	)

Value:

    inline E operator | (E lhs, E rhs){\
        return E(T(lhs) | T(rhs));\
    }\
    inline E operator & (E lhs, E rhs){\
        return E(T(lhs) & T(rhs));\
    }\
    inline E operator ^ (E lhs, E rhs){\
        return E(T(lhs) ^ T(rhs));\
    }\
    inline E operator ~ (E lhs){\
        return E(~T(lhs));\
    }\
    inline E operator |= (E &lhs, E rhs){\
        lhs = lhs | rhs;\
        return lhs;\
    }\
    inline E operator &= (E &lhs, E rhs){\
        lhs = lhs & rhs;\
        return lhs;\
    }\
    inline E operator ^= (E &lhs, E rhs){\
        lhs = lhs ^ rhs;\
        return lhs;\
    }\
    inline bool operator !(E rhs) \
    {\
        return !bool(T(rhs)); \
    }

Definition at line 250 of file flatbuffers.h.

                                      {\
        return E(T(lhs) | T(rhs));\
    }\
    inline E operator & (E lhs, E rhs){\
        return E(T(lhs) & T(rhs));\
    }\
    inline E operator ^ (E lhs, E rhs){\
        return E(T(lhs) ^ T(rhs));\
    }\
    inline E operator ~ (E lhs){\
        return E(~T(lhs));\
    }\
    inline E operator |= (E &lhs, E rhs){\
        lhs = lhs | rhs;\
        return lhs;\
    }\
    inline E operator &= (E &lhs, E rhs){\
        lhs = lhs & rhs;\
        return lhs;\
    }\
    inline E operator ^= (E &lhs, E rhs){\
        lhs = lhs ^ rhs;\
        return lhs;\
    }\
    inline bool operator !(E rhs) \
    {\
        return !bool(T(rhs)); \
    }

FLATBUFFERS_ET [1/2]

#define FLATBUFFERS_ET

(

E

)

E,

Definition at line 197 of file flatbuffers.h.

FLATBUFFERS_ET [2/2]

#define FLATBUFFERS_ET

(

E

)

#E,

Definition at line 197 of file flatbuffers.h.

FLATBUFFERS_GEN_ELEMENTARY_TYPES

#define FLATBUFFERS_GEN_ELEMENTARY_TYPES

(

ET

)

Value:

  ET(ET_UTYPE) \
  ET(ET_BOOL) \
  ET(ET_CHAR) \
  ET(ET_UCHAR) \
  ET(ET_SHORT) \
  ET(ET_USHORT) \
  ET(ET_INT) \
  ET(ET_UINT) \
  ET(ET_LONG) \
  ET(ET_ULONG) \
  ET(ET_FLOAT) \
  ET(ET_DOUBLE) \
  ET(ET_STRING) \
  ET(ET_SEQUENCE)

Definition at line 180 of file flatbuffers.h.