flatbuffers::vector_downward Class Reference

#include <flatbuffers.h>

Public Member Functions
	vector_downward (size_t initial_size, Allocator *allocator, bool own_allocator, size_t buffer_minalign)
	vector_downward (vector_downward &&other)
vector_downward &	operator= (vector_downward &&other)
	~vector_downward ()
void	reset ()
void	clear ()
void	clear_scratch ()
void	clear_allocator ()
void	clear_buffer ()
uint8_t *	release_raw (size_t &allocated_bytes, size_t &offset)
DetachedBuffer	release ()
size_t	ensure_space (size_t len)
uint8_t *	make_space (size_t len)
Allocator *	get_custom_allocator ()
uoffset_t	size () const
uoffset_t	scratch_size () const
size_t	capacity () const
uint8_t *	data () const
uint8_t *	scratch_data () const
uint8_t *	scratch_end () const
uint8_t *	data_at (size_t offset) const
void	push (const uint8_t *bytes, size_t num)
template<typename T >
void	push_small (const T &little_endian_t)
template<typename T >
void	scratch_push_small (const T &t)
void	fill (size_t zero_pad_bytes)
void	fill_big (size_t zero_pad_bytes)
void	pop (size_t bytes_to_remove)
void	scratch_pop (size_t bytes_to_remove)
void	swap (vector_downward &other)
void	swap_allocator (vector_downward &other)

Detailed Description

Definition at line 875 of file flatbuffers.h.

Constructor & Destructor Documentation

vector_downward() [1/2]

flatbuffers::vector_downward::vector_downward ( size_t  initial_size, Allocator *  allocator, bool  own_allocator, size_t  buffer_minalign  )

inlineexplicit

Definition at line 878 of file flatbuffers.h.

    : allocator_(allocator), own_allocator_(own_allocator), initial_size_(initial_size),
      buffer_minalign_(buffer_minalign), reserved_(0), buf_(nullptr), cur_(nullptr),
      scratch_(nullptr)
  {
  }

vector_downward() [2/2]

flatbuffers::vector_downward::vector_downward ( vector_downward &&  other )

inline

Definition at line 887 of file flatbuffers.h.

    : allocator_(other.allocator_), own_allocator_(other.own_allocator_),
      initial_size_(other.initial_size_), buffer_minalign_(other.buffer_minalign_),
      reserved_(other.reserved_), buf_(other.buf_), cur_(other.cur_), scratch_(other.scratch_)
  {
    // No change in other.allocator_
    // No change in other.initial_size_
    // No change in other.buffer_minalign_
    other.own_allocator_ = false;
    other.reserved_ = 0;
    other.buf_ = nullptr;
    other.cur_ = nullptr;
    other.scratch_ = nullptr;
  }

~vector_downward()

flatbuffers::vector_downward::~vector_downward ( )

inline

Definition at line 918 of file flatbuffers.h.

  {
    clear_buffer();
    clear_allocator();
  }

References clear_allocator(), and clear_buffer().

Member Function Documentation

capacity()

size_t flatbuffers::vector_downward::capacity ( ) const

inline

Definition at line 1022 of file flatbuffers.h.

{ return reserved_; }

Referenced by flatbuffers::grpc::MessageBuilder::GetMessage(), and flatbuffers::grpc::MessageBuilder::MessageBuilder().

clear()

void flatbuffers::vector_downward::clear ( )

inline

Definition at line 930 of file flatbuffers.h.

  {
    if (buf_)
    {
      cur_ = buf_ + reserved_;
    }
    else
    {
      reserved_ = 0;
      cur_ = nullptr;
    }
    clear_scratch();
  }

References clear_scratch().

Referenced by flatbuffers::FlatBufferBuilder::Clear(), release(), release_raw(), and reset().

clear_allocator()

void flatbuffers::vector_downward::clear_allocator ( )

inline

Definition at line 946 of file flatbuffers.h.

  {
    if (own_allocator_ && allocator_)
    {
      delete allocator_;
    }
    allocator_ = nullptr;
    own_allocator_ = false;
  }

Referenced by ~vector_downward().

clear_buffer()

void flatbuffers::vector_downward::clear_buffer ( )

inline

Definition at line 956 of file flatbuffers.h.

  {
    if (buf_)
      Deallocate(allocator_, buf_, reserved_);
    buf_ = nullptr;
  }

References flatbuffers::Deallocate().

Referenced by reset(), and ~vector_downward().

clear_scratch()

void flatbuffers::vector_downward::clear_scratch ( )

inline

Definition at line 944 of file flatbuffers.h.

{ scratch_ = buf_; }

Referenced by clear(), and flatbuffers::FlatBufferBuilder::Finish().

data()

uint8_t * flatbuffers::vector_downward::data ( ) const

inline

Definition at line 1024 of file flatbuffers.h.

  {
    FLATBUFFERS_ASSERT(cur_);
    return cur_;
  }

References FLATBUFFERS_ASSERT.

Referenced by flatbuffers::FlatBufferBuilder::GetBufferPointer(), flatbuffers::FlatBufferBuilder::GetBufferSpan(), flatbuffers::FlatBufferBuilder::GetCurrentBufferPointer(), and flatbuffers::grpc::MessageBuilder::GetMessage().

data_at()

uint8_t * flatbuffers::vector_downward::data_at ( size_t  offset ) const

inline

Definition at line 1042 of file flatbuffers.h.

{ return buf_ + reserved_ - offset; }

References offset().

Referenced by flatbuffers::FlatBufferBuilder::CreateUninitializedVector(), and flatbuffers::FlatBufferBuilder::StringOffsetCompare::operator()().

ensure_space()

size_t flatbuffers::vector_downward::ensure_space ( size_t  len )

inline

Definition at line 992 of file flatbuffers.h.

  {
    FLATBUFFERS_ASSERT(cur_ >= scratch_ && scratch_ >= buf_);
    if (len > static_cast<size_t>(cur_ - scratch_))
    {
      reallocate(len);
    }
    // Beyond this, signed offsets may not have enough range:
    // (FlatBuffers > 2GB not supported).
    FLATBUFFERS_ASSERT(size() < FLATBUFFERS_MAX_BUFFER_SIZE);
    return len;
  }

References FLATBUFFERS_ASSERT, and size().

Referenced by make_space(), and scratch_push_small().

fill()

void flatbuffers::vector_downward::fill ( size_t  zero_pad_bytes )

inline

Definition at line 1068 of file flatbuffers.h.

  {
    make_space(zero_pad_bytes);
    for (size_t i = 0; i < zero_pad_bytes; i++)
      cur_[i] = 0;
  }

References make_space().

Referenced by flatbuffers::FlatBufferBuilder::CreateString().

fill_big()

void flatbuffers::vector_downward::fill_big ( size_t  zero_pad_bytes )

inline

Definition at line 1077 of file flatbuffers.h.

{ memset(make_space(zero_pad_bytes), 0, zero_pad_bytes); }

References make_space().

get_custom_allocator()

Allocator * flatbuffers::vector_downward::get_custom_allocator ( )

inline

Definition at line 1013 of file flatbuffers.h.

{ return allocator_; }

make_space()

uint8_t * flatbuffers::vector_downward::make_space ( size_t  len )

inline

Definition at line 1005 of file flatbuffers.h.

  {
    size_t space = ensure_space(len);
    cur_ -= space;
    return cur_;
  }

References ensure_space().

Referenced by flatbuffers::FlatBufferBuilder::CreateUninitializedVector(), fill(), fill_big(), push(), and push_small().

operator=()

vector_downward & flatbuffers::vector_downward::operator= ( vector_downward &&  other )

inline

Definition at line 908 of file flatbuffers.h.

  {
    // Move construct a temporary and swap idiom
    vector_downward temp(std::move(other));
    swap(temp);
    return *this;
  }

References swap().

pop()

void flatbuffers::vector_downward::pop ( size_t  bytes_to_remove )

inline

Definition at line 1079 of file flatbuffers.h.

{ cur_ += bytes_to_remove; }

Referenced by flatbuffers::FlatBufferBuilder::CreateSharedString().

push()

void flatbuffers::vector_downward::push ( const uint8_t *  bytes, size_t  num  )

inline

Definition at line 1044 of file flatbuffers.h.

  {
    if (num > 0)
    {
      memcpy(make_space(num), bytes, num);
    }
  }

References make_space().

push_small()

template<typename T >

void flatbuffers::vector_downward::push_small ( const T &  little_endian_t )

inline

Definition at line 1053 of file flatbuffers.h.

  {
    make_space(sizeof(T));
    *reinterpret_cast<T *>(cur_) = little_endian_t;
  }

References make_space().

Referenced by flatbuffers::FlatBufferBuilder::CreateStruct().

release()

DetachedBuffer flatbuffers::vector_downward::release ( )

inline

Definition at line 978 of file flatbuffers.h.

  {
    // allocator ownership (if any) is transferred to DetachedBuffer.
    DetachedBuffer fb(allocator_, own_allocator_, buf_, reserved_, cur_, size());
    if (own_allocator_)
    {
      allocator_ = nullptr;
      own_allocator_ = false;
    }
    buf_ = nullptr;
    clear();
    return fb;
  }

References clear(), and size().

Referenced by flatbuffers::FlatBufferBuilder::FLATBUFFERS_ATTRIBUTE(), and flatbuffers::FlatBufferBuilder::Release().

release_raw()

uint8_t * flatbuffers::vector_downward::release_raw ( size_t &  allocated_bytes, size_t &  offset  )

inline

Definition at line 964 of file flatbuffers.h.

  {
    auto *buf = buf_;
    allocated_bytes = reserved_;
    offset = static_cast<size_t>(cur_ - buf_);
 
    // release_raw only relinquishes the buffer ownership.
    // Does not deallocate or reset the allocator. Destructor will do that.
    buf_ = nullptr;
    clear();
    return buf;
  }

References clear(), and offset().

Referenced by flatbuffers::FlatBufferBuilder::ReleaseRaw().

reset()

void flatbuffers::vector_downward::reset ( )

inline

Definition at line 924 of file flatbuffers.h.

  {
    clear_buffer();
    clear();
  }

References clear(), and clear_buffer().

Referenced by flatbuffers::FlatBufferBuilder::Reset().

scratch_data()

uint8_t * flatbuffers::vector_downward::scratch_data ( ) const

inline

Definition at line 1030 of file flatbuffers.h.

  {
    FLATBUFFERS_ASSERT(buf_);
    return buf_;
  }

References FLATBUFFERS_ASSERT.

Referenced by flatbuffers::grpc::MessageBuilder::GetMessage(), and flatbuffers::grpc::MessageBuilder::MessageBuilder().

scratch_end()

uint8_t * flatbuffers::vector_downward::scratch_end ( ) const

inline

Definition at line 1036 of file flatbuffers.h.

  {
    FLATBUFFERS_ASSERT(scratch_);
    return scratch_;
  }

References FLATBUFFERS_ASSERT.

scratch_pop()

void flatbuffers::vector_downward::scratch_pop ( size_t  bytes_to_remove )

inline

Definition at line 1080 of file flatbuffers.h.

{ scratch_ -= bytes_to_remove; }

scratch_push_small()

template<typename T >

void flatbuffers::vector_downward::scratch_push_small ( const T &  t )

inline

Definition at line 1059 of file flatbuffers.h.

  {
    ensure_space(sizeof(T));
    *reinterpret_cast<T *>(scratch_) = t;
    scratch_ += sizeof(T);
  }

References ensure_space().

scratch_size()

uoffset_t flatbuffers::vector_downward::scratch_size ( ) const

inline

Definition at line 1020 of file flatbuffers.h.

{ return static_cast<uoffset_t>(scratch_ - buf_); }

size()

uoffset_t flatbuffers::vector_downward::size ( ) const

inline

Definition at line 1015 of file flatbuffers.h.

  {
    return static_cast<uoffset_t>(reserved_ - static_cast<size_t>(cur_ - buf_));
  }

Referenced by flatbuffers::FlatBufferBuilder::CreateSharedString(), ensure_space(), flatbuffers::FlatBufferBuilder::GetBufferSpan(), flatbuffers::grpc::MessageBuilder::GetMessage(), flatbuffers::FlatBufferBuilder::GetSize(), and release().

swap()

void flatbuffers::vector_downward::swap ( vector_downward &  other )

inline

Definition at line 1082 of file flatbuffers.h.

  {
    using std::swap;
    swap(allocator_, other.allocator_);
    swap(own_allocator_, other.own_allocator_);
    swap(initial_size_, other.initial_size_);
    swap(buffer_minalign_, other.buffer_minalign_);
    swap(reserved_, other.reserved_);
    swap(buf_, other.buf_);
    swap(cur_, other.cur_);
    swap(scratch_, other.scratch_);
  }

References swap().

Referenced by operator=(), flatbuffers::FlatBufferBuilder::Swap(), swap(), and swap_allocator().

swap_allocator()

void flatbuffers::vector_downward::swap_allocator ( vector_downward &  other )

inline

Definition at line 1095 of file flatbuffers.h.

  {
    using std::swap;
    swap(allocator_, other.allocator_);
    swap(own_allocator_, other.own_allocator_);
  }

References swap().

Referenced by flatbuffers::grpc::MessageBuilder::Swap(), and flatbuffers::FlatBufferBuilder::SwapBufAllocator().

---

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

• onert-micro/externals/flatbuffers/flatbuffers.h