mtcore::FixedQueue< T, Capacity > Struct Template Reference

Statically allocated FIFO queue with fixed maximum capacity. More...

#include <queue.hpp>

Inheritance diagram for mtcore::FixedQueue< T, Capacity >:

Public Member Functions
Result< void, AllocationError >	init ()
	Initializes Queue with capacity.
Result< void, AllocationError >	init (std::initializer_list< T > init)
	Initializes Queue with initial items.
size_t	size () const noexcept
size_t	capacity () const noexcept
Optional< T >	peek () const noexcept
	Peeks at first element of Queue.
Optional< T >	pop () noexcept
	Removes and returns the next element in the Queue.
Result< void, CollectionAddNoAllocationError >	push (const T &elem) noexcept
	Tries to add an element to the Queue Fails if Queue is empty.
bool	is_full () const noexcept
	Checks if ring buffer is full.
bool	is_empty () const noexcept
	Checks if ring buffer is empty.

Detailed Description

template<typename T, size_t Capacity>
struct mtcore::FixedQueue< T, Capacity >

Statically allocated FIFO queue with fixed maximum capacity.

Template Parameters

T	Element to store
Capacity	Maximum capacity of queue

Adding elements is \(O(1)\) Removing elements is \(O(1)\)

Definition at line 156 of file queue.hpp.

Member Function Documentation

capacity()

template<typename T, size_t Capacity>

size_t mtcore::FixedQueue< T, Capacity >::capacity ( ) const

inlinenodiscardnoexcept

Returns

Capacity of Queue

Definition at line 182 of file queue.hpp.

{ return Capacity; }

Here is the caller graph for this function:

init() [1/2]

template<typename T, size_t Capacity>

Result< void, AllocationError > mtcore::FixedQueue< T, Capacity >::init ( )

inline

Initializes Queue with capacity.

Returns

success or failure

Definition at line 165 of file queue.hpp.

{ return buffer.init(); }

Here is the caller graph for this function:

init() [2/2]

template<typename T, size_t Capacity>

Result< void, AllocationError > mtcore::FixedQueue< T, Capacity >::init ( std::initializer_list< T > init )

inline

Initializes Queue with initial items.

Parameters

init	Initial elements

Returns

success or failure

Definition at line 172 of file queue.hpp.

{ return buffer.init(init); }

Here is the call graph for this function:

is_empty()

template<typename T, size_t Capacity>

bool mtcore::FixedQueue< T, Capacity >::is_empty ( ) const

inlinenodiscardnoexcept

Checks if ring buffer is empty.

Returns

true if ring buffer is empty

Definition at line 225 of file queue.hpp.

{ return size() == 0; }

Here is the call graph for this function:

is_full()

template<typename T, size_t Capacity>

bool mtcore::FixedQueue< T, Capacity >::is_full ( ) const

inlinenodiscardnoexcept

Checks if ring buffer is full.

Returns

true if ring buffer is full

Definition at line 219 of file queue.hpp.

{ return size() >= Capacity; }

Here is the call graph for this function:

peek()

template<typename T, size_t Capacity>

Optional< T > mtcore::FixedQueue< T, Capacity >::peek ( ) const

inlinenoexcept

Peeks at first element of Queue.

Returns

First elem or nullopt

Definition at line 188 of file queue.hpp.

                                      {
      if (buffer.size() > 0) {
        return buffer.at(0);
      }
      return nullopt;
    }

pop()

template<typename T, size_t Capacity>

Optional< T > mtcore::FixedQueue< T, Capacity >::pop ( )

inlinenoexcept

Removes and returns the next element in the Queue.

Returns

Next elem in Queue or nullopt

Definition at line 199 of file queue.hpp.

                               {
      mtdefer { ensure(size() <= capacity(), "SIZE MISMATCH"); };
      return buffer.pop_front();
    }

Here is the call graph for this function:

push()

template<typename T, size_t Capacity>

Result< void, CollectionAddNoAllocationError > mtcore::FixedQueue< T, Capacity >::push ( const T & elem )

inlinenoexcept

Tries to add an element to the Queue Fails if Queue is empty.

Parameters

elem	Element to add

Returns

Success or failure

Definition at line 210 of file queue.hpp.

                                                                              {
      mtdefer { ensure(size() <= capacity(), "SIZE MISMATCH"); };
      return buffer.push_back(elem);
    }

Here is the call graph for this function:

size()

template<typename T, size_t Capacity>

size_t mtcore::FixedQueue< T, Capacity >::size ( ) const

inlinenodiscardnoexcept

Returns

Size of Queue

Definition at line 177 of file queue.hpp.

{ return buffer.size(); }

Here is the caller graph for this function:

---

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

• queue.hpp