basic_memory_buffer< T, SIZE, Allocator > Class Template Reference

#include <format.h>

Inheritance diagram for basic_memory_buffer< T, SIZE, Allocator >:

Public Types
typedef T	value_type
typedef const T &	const_reference
Public Types inherited from internal::basic_buffer< T >
typedef T	value_type
typedef const T &	const_reference

Public Member Functions
	basic_memory_buffer (const Allocator &alloc=Allocator())
	~basic_memory_buffer ()
	basic_memory_buffer (basic_memory_buffer &&other)
basic_memory_buffer &	operator= (basic_memory_buffer &&other)
Allocator	get_allocator () const
Public Member Functions inherited from internal::basic_buffer< T >
virtual	~basic_buffer ()
T *	begin () FMT_NOEXCEPT
T *	end () FMT_NOEXCEPT
std::size_t	size () const FMT_NOEXCEPT
std::size_t	capacity () const FMT_NOEXCEPT
T *	data () FMT_NOEXCEPT
const T *	data () const FMT_NOEXCEPT
void	resize (std::size_t new_size)
void	clear ()
void	reserve (std::size_t new_capacity)
void	push_back (const T &value)
template<typename U >
void	append (const U *begin, const U *end)
T &	operator[] (std::size_t index)
const T &	operator[] (std::size_t index) const

Protected Member Functions
void	grow (std::size_t size) FMT_OVERRIDE
Protected Member Functions inherited from internal::basic_buffer< T >
	basic_buffer (std::size_t sz) FMT_NOEXCEPT
	basic_buffer (T *p=FMT_NULL, std::size_t sz=0, std::size_t cap=0) FMT_NOEXCEPT
void	set (T *buf_data, std::size_t buf_capacity) FMT_NOEXCEPT

Private Member Functions
void	deallocate ()
void	move (basic_memory_buffer &other)

Private Attributes
T	store_ [SIZE]

Detailed Description

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>
class basic_memory_buffer< T, SIZE, Allocator >

A dynamically growing memory buffer for trivially copyable/constructible types with the first SIZE elements stored in the object itself.

You can use one of the following typedefs for common character types:

+-------------—+---------------------------—+ | Type | Definition | +================+==============================+ | memory_buffer | basic_memory_buffer<char> | +-------------—+---------------------------—+ | wmemory_buffer | basic_memory_buffer<wchar_t> | +-------------—+---------------------------—+

Example**::

fmt::memory_buffer out; format_to(out, "The answer is {}.", 42);

This will append the following output to the out object:

.. code-block:: none

The answer is 42.

The output can be converted to an std::string with to_string(out).

Definition at line 464 of file format.h.

Member Typedef Documentation

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

typedef const T& basic_memory_buffer< T, SIZE, Allocator >::const_reference

Definition at line 479 of file format.h.

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

typedef T basic_memory_buffer< T, SIZE, Allocator >::value_type

Definition at line 478 of file format.h.

Constructor & Destructor Documentation

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

basic_memory_buffer< T, SIZE, Allocator >::basic_memory_buffer ( const Allocator &  alloc = Allocator() )

inlineexplicit

Definition at line 481 of file format.h.

      : Allocator(alloc) {
    this->set(store_, SIZE);
  }

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

basic_memory_buffer< T, SIZE, Allocator >::~basic_memory_buffer ( )

inline

Definition at line 485 of file format.h.

{ deallocate(); }

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

basic_memory_buffer< T, SIZE, Allocator >::basic_memory_buffer ( basic_memory_buffer< T, SIZE, Allocator > &&  other )

inline

Constructs a :class:fmt::basic_memory_buffer object moving the content of the other object to it.

Definition at line 514 of file format.h.

                                                   {
    move(other);
  }

Member Function Documentation

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

void basic_memory_buffer< T, SIZE, Allocator >::deallocate ( )

inlineprivate

Definition at line 469 of file format.h.

                    {
    T* data = this->data();
    if (data != store_) Allocator::deallocate(data, this->capacity());
  }

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

Allocator basic_memory_buffer< T, SIZE, Allocator >::get_allocator ( ) const

inline

Definition at line 531 of file format.h.

{ return *this; }

template<typename T , std::size_t SIZE, typename Allocator >

void basic_memory_buffer< T, SIZE, Allocator >::grow ( std::size_t  capacity )

protectedvirtual

Increases the buffer capacity to hold at least capacity elements.

Implements internal::basic_buffer< T >.

Definition at line 535 of file format.h.

                                                                 {
  std::size_t old_capacity = this->capacity();
  std::size_t new_capacity = old_capacity + old_capacity / 2;
  if (size > new_capacity)
      new_capacity = size;
  T *old_data = this->data();
  T *new_data = internal::allocate<Allocator>(*this, new_capacity);
  // The following code doesn't throw, so the raw pointer above doesn't leak.
  std::uninitialized_copy(old_data, old_data + this->size(),
                          internal::make_checked(new_data, new_capacity));
  this->set(new_data, new_capacity);
  // deallocate must not throw according to the standard, but even if it does,
  // the buffer already uses the new storage and will deallocate it in
  // destructor.
  if (old_data != store_)
    Allocator::deallocate(old_data, old_capacity);
}

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

void basic_memory_buffer< T, SIZE, Allocator >::move ( basic_memory_buffer< T, SIZE, Allocator > &  other )

inlineprivate

Definition at line 489 of file format.h.

                                        {
    Allocator &this_alloc = *this, &other_alloc = other;
    this_alloc = std::move(other_alloc);
    T* data = other.data();
    std::size_t size = other.size(), capacity = other.capacity();
    if (data == other.store_) {
      this->set(store_, capacity);
      std::uninitialized_copy(other.store_, other.store_ + size,
                              internal::make_checked(store_, capacity));
    } else {
      this->set(data, capacity);
      // Set pointer to the inline array so that delete is not called
      // when deallocating.
      other.set(other.store_, 0);
    }
    this->resize(size);
  }

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

basic_memory_buffer& basic_memory_buffer< T, SIZE, Allocator >::operator= ( basic_memory_buffer< T, SIZE, Allocator > &&  other )

inline

Moves the content of the other basic_memory_buffer object to this one.

Definition at line 523 of file format.h.

                                                              {
    assert(this != &other);
    deallocate();
    move(other);
    return *this;
  }

Member Data Documentation

template<typename T, std::size_t SIZE = inline_buffer_size, typename Allocator = std::allocator<T>>

T basic_memory_buffer< T, SIZE, Allocator >::store_[SIZE]

private

Definition at line 466 of file format.h.

---

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

• wire-cell-build/util/inc/spdlog/fmt/bundled/format.h