dynamic_queue.h

// Copyright 2025 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
 
#include <utility>
 
#include "pw_allocator/allocator.h"
#include "pw_containers/dynamic_deque.h"
#include "pw_containers/internal/generic_queue.h"
 
namespace pw {
 
 
 
template <typename T, typename SizeType = uint16_t>
class DynamicQueue
    : public containers::internal::GenericQueue<DynamicQueue<T, SizeType>,
                                                DynamicDeque<T, SizeType>> {
 private:
  using Deque = DynamicDeque<T, SizeType>;
  using Base = containers::internal::GenericQueue<DynamicQueue, Deque>;
 
 public:
  using const_iterator = typename Deque::const_iterator;
  using const_pointer = typename Deque::const_pointer;
  using const_reference = typename Deque::const_reference;
  using difference_type = typename Deque::difference_type;
  using iterator = typename Deque::iterator;
  using pointer = typename Deque::pointer;
  using reference = typename Deque::reference;
  using size_type = typename Deque::size_type;
  using value_type = typename Deque::value_type;
 
  explicit constexpr DynamicQueue(pw::Allocator& allocator)
      : deque_(allocator) {}
 
  // Disable copy since it can fail.
  DynamicQueue(const DynamicQueue&) = delete;
  DynamicQueue& operator=(const DynamicQueue&) = delete;
 
  constexpr DynamicQueue(DynamicQueue&&) = default;
  DynamicQueue& operator=(DynamicQueue&&) = default;
 
  [[nodiscard]] bool try_push(const value_type& value) {
    return deque_.try_push_back(value);
  }
 
  [[nodiscard]] bool try_push(value_type&& value) {
    return deque_.try_push_back(std::move(value));
  }
 
  template <typename... Args>
  [[nodiscard]] bool try_emplace(Args&&... args) {
    return deque_.try_emplace_back(std::forward<Args>(args)...);
  }
 
  void reserve(size_type capacity) { deque_.reserve(capacity); }
 
  [[nodiscard]] bool try_reserve(size_type capacity) {
    return deque_.try_reserve(capacity);
  }
 
  void reserve_exact(size_type capacity) { deque_.reserve_exact(capacity); }
 
  [[nodiscard]] bool try_reserve_exact(size_type capacity) {
    return deque_.try_reserve_exact(capacity);
  }
 
  void shrink_to_fit() { deque_.shrink_to_fit(); }
 
  void reset() { deque_.reset(); }
 
  void swap(DynamicQueue& other) { deque_.swap(other.deque_); }
 
 private:
  friend Base;
 
  // Hide full() since the capacity can grow.
  using Base::full;
 
  Deque& deque() { return deque_; }
  const Deque& deque() const { return deque_; }
 
  Deque deque_;
};
 
}  // namespace pw