history_buffer.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <functional>
#include <memory>
#include <optional>
 
#include "contur/core/error.h"
 
#include "contur/tui/tui_models.h"
 
namespace contur {

    class HistoryBuffer final
    {
        public:
        explicit HistoryBuffer(std::size_t capacity);

        ~HistoryBuffer();

        HistoryBuffer(const HistoryBuffer &) = delete;

        HistoryBuffer &operator=(const HistoryBuffer &) = delete;

        HistoryBuffer(HistoryBuffer &&) noexcept;

        HistoryBuffer &operator=(HistoryBuffer &&) noexcept;

        [[nodiscard]] Result<void> append(TuiHistoryEntry entry);

        [[nodiscard]] Result<void> seekBackward(std::size_t step);

        [[nodiscard]] Result<void> seekForward(std::size_t step);

        void moveToLatest() noexcept;

        [[nodiscard]] std::optional<std::reference_wrapper<const TuiHistoryEntry>> current() const noexcept;

        [[nodiscard]] std::optional<std::reference_wrapper<const TuiHistoryEntry>> latest() const noexcept;

        [[nodiscard]] bool empty() const noexcept;

        [[nodiscard]] std::size_t size() const noexcept;

        [[nodiscard]] std::size_t capacity() const noexcept;

        [[nodiscard]] std::size_t cursor() const noexcept;
 
        private:
        struct Impl;
        std::unique_ptr<Impl> impl_;
    };
 
} // namespace contur