tim::circular_buffer::BufferShape< SizeType > Struct Template Reference

#include <tim/circular-buffer/CircularBuffer.hpp>

Public Attributes
SizeType	capacity = 0
SizeType	start = 0

Friends
constexpr friend auto	operator<=> (const BufferShape &lhs, const BufferShape &rhs)=default

Detailed Description

template<class SizeType>
struct tim::circular_buffer::BufferShape< SizeType >

Simple type used to describe the layout of a circular buffer.

Friends And Related Function Documentation

operator<=>

template<class SizeType >

constexpr friend auto operator<=> ( const BufferShape< SizeType > &  lhs, const BufferShape< SizeType > &  rhs  )

friend

Defaulted comparison operators.

Member Data Documentation

capacity

template<class SizeType >

SizeType tim::circular_buffer::BufferShape< SizeType >::capacity = 0

Capacity of the buffer.

start

template<class SizeType >

SizeType tim::circular_buffer::BufferShape< SizeType >::start = 0

Physical index into the buffer of logical index 0 (begin_index()).

---

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

• C:/Users/vansl/source/repos/circular-buffer-cpp/include/tim/circular-buffer/CircularBuffer.hpp