FastLED 3.9.7
Loading...
Searching...
No Matches
fl::CircularBuffer< T > Class Template Reference

Detailed Description

template<typename T>
class fl::CircularBuffer< T >

Definition at line 12 of file circular_buffer.h.

Public Member Functions

 CircularBuffer (size_t capacity)
 
 CircularBuffer (const CircularBuffer &)=delete
 
CircularBufferoperator= (const CircularBuffer &)=delete
 
bool push_back (const T &value)
 
bool pop_front (T *dst=nullptr)
 
bool push_front (const T &value)
 
bool pop_back (T *dst=nullptr)
 
T & front ()
 
const T & front () const
 
T & back ()
 
const T & back () const
 
T & operator[] (size_t index)
 
const T & operator[] (size_t index) const
 
size_t size () const
 
size_t capacity () const
 
bool empty () const
 
bool full () const
 
void clear ()
 

Constructor & Destructor Documentation

◆ CircularBuffer()

template<typename T >
fl::CircularBuffer< T >::CircularBuffer ( size_t capacity)
inline

Definition at line 14 of file circular_buffer.h.

Member Function Documentation

◆ back() [1/2]

template<typename T >
T & fl::CircularBuffer< T >::back ( )
inline

Definition at line 70 of file circular_buffer.h.

◆ back() [2/2]

template<typename T >
const T & fl::CircularBuffer< T >::back ( ) const
inline

Definition at line 74 of file circular_buffer.h.

◆ capacity()

template<typename T >
size_t fl::CircularBuffer< T >::capacity ( ) const
inline

Definition at line 90 of file circular_buffer.h.

◆ clear()

template<typename T >
void fl::CircularBuffer< T >::clear ( )
inline

Definition at line 102 of file circular_buffer.h.

◆ empty()

template<typename T >
bool fl::CircularBuffer< T >::empty ( ) const
inline

Definition at line 94 of file circular_buffer.h.

◆ front() [1/2]

template<typename T >
T & fl::CircularBuffer< T >::front ( )
inline

Definition at line 62 of file circular_buffer.h.

◆ front() [2/2]

template<typename T >
const T & fl::CircularBuffer< T >::front ( ) const
inline

Definition at line 66 of file circular_buffer.h.

◆ full()

template<typename T >
bool fl::CircularBuffer< T >::full ( ) const
inline

Definition at line 98 of file circular_buffer.h.

◆ operator[]() [1/2]

template<typename T >
T & fl::CircularBuffer< T >::operator[] ( size_t index)
inline

Definition at line 78 of file circular_buffer.h.

◆ operator[]() [2/2]

template<typename T >
const T & fl::CircularBuffer< T >::operator[] ( size_t index) const
inline

Definition at line 82 of file circular_buffer.h.

◆ pop_back()

template<typename T >
bool fl::CircularBuffer< T >::pop_back ( T * dst = nullptr)
inline

Definition at line 51 of file circular_buffer.h.

◆ pop_front()

template<typename T >
bool fl::CircularBuffer< T >::pop_front ( T * dst = nullptr)
inline

Definition at line 31 of file circular_buffer.h.

◆ push_back()

template<typename T >
bool fl::CircularBuffer< T >::push_back ( const T & value)
inline

Definition at line 22 of file circular_buffer.h.

◆ push_front()

template<typename T >
bool fl::CircularBuffer< T >::push_front ( const T & value)
inline

Definition at line 42 of file circular_buffer.h.

◆ size()

template<typename T >
size_t fl::CircularBuffer< T >::size ( ) const
inline

Definition at line 86 of file circular_buffer.h.


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