Class basic_queue_t

lib/include/basic_queue_t.hpp:49–186

    ///
    template<typename T, bsl::uintmx N>
    class basic_queue_t final
    {
        /// @brief stores a circular buffer for the queue.
        bsl::array<T, N> m_queue{};
        /// @brief stores the head of the queue.
        bsl::safe_idx m_head{};
        /// @brief stores the tail of the queue.
        bsl::safe_idx m_tail{};

    public:
        /// @brief alias for: T
        using value_type = T;
        /// @brief alias for: safe_umx
        using size_type = bsl::safe_umx;
        /// @brief alias for: safe_idx
        using index_type = bsl::safe_idx;
        /// @brief alias for: safe_umx
        using difference_type = bsl::safe_umx;
        /// @brief alias for: T &
        using reference_type = T &;
        /// @brief alias for: T const &
        using const_reference_type = T const &;
        /// @brief alias for: T *
        using pointer_type = T *;
        /// @brief alias for: T const *
        using const_pointer_type = T const *;

        /// <!-- description -->
        ///   @brief Pushes an element to the queue and returns
        ///     bsl::errc_success. If the queue is full, returns
        ///     bsl::errc_failure.
        ///
        /// <!-- inputs/outputs -->
        ///   @param val the value to push to the queue
        ///   @param sloc the source location of the push for debugging
        ///   @return Returns bsl::errc_success on success, or
        ///     bsl::errc_failure if the queue is full.
        ///
        [[nodiscard]] constexpr auto
        push(T const &val, bsl::source_location const &sloc = bsl::here()) noexcept
            -> bsl::errc_type
        {
            if (bsl::unlikely(this->full())) {
                bsl::error() << "queue is full\n" << sloc;
                return bsl::errc_failure;
            }

            *m_queue.at_if(m_head) = val;

            ++m_head;
            if (m_head >= N) {
                m_head = {};
            }
            else {
                bsl::touch();
            }

            return bsl::errc_success;