StaticRingBuffer.h

#pragma once
 
#include <Foundation/Containers/StaticArray.h>
 
template <typename T, plUInt32 Capacity>
class plStaticRingBuffer
{
public:
  static_assert(Capacity > 1, "ORLY?");
 
  plStaticRingBuffer(); // [tested]
 
  plStaticRingBuffer(const plStaticRingBuffer<T, Capacity>& rhs); // [tested]
 
  ~plStaticRingBuffer(); // [tested]
 
  void operator=(const plStaticRingBuffer<T, Capacity>& rhs); // [tested]
 
  bool operator==(const plStaticRingBuffer<T, Capacity>& rhs) const; // [tested]
  PL_ADD_DEFAULT_OPERATOR_NOTEQUAL(const plStaticRingBuffer<T, Capacity>&);
 
  void PushBack(const T& element); // [tested]
 
  void PushBack(T&& element); // [tested]
 
  T& PeekBack(); // [tested]
 
  const T& PeekBack() const; // [tested]
 
  void PopFront(plUInt32 uiElements = 1); // [tested]
 
  const T& PeekFront() const; // [tested]
 
  T& PeekFront(); // [tested]
 
  const T& operator[](plUInt32 uiIndex) const; // [tested]
 
  T& operator[](plUInt32 uiIndex); // [tested]
 
  plUInt32 GetCount() const; // [tested]
 
  bool IsEmpty() const; // [tested]
 
  bool CanAppend(plUInt32 uiElements = 1); // [tested]
 
  void Clear(); // [tested]
 
  const T* GetElements() const { return m_pElements; }
 
private:
  T* GetStaticArray();
 
  struct alignas(PL_ALIGNMENT_OF(T))
  {
    plUInt8 m_Data[Capacity * sizeof(T)];
  };
 
  T* m_pElements;
  plUInt32 m_uiCount;
  plUInt32 m_uiFirstElement;
};
 
#include <Foundation/Containers/Implementation/StaticRingBuffer_inl.h>