rows.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Database.
 *
 * StormByte-Database original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Database source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-Logger tree and
 * the PostgreSQL, MariaDB and SQLite trees), which remain under their own
 * licenses.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Database is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Database. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/database/row.hxx>
#include <StormByte/size.hxx>
 
#include <iterator>
#include <memory>
 
namespace StormByte {
    namespace Database {
        class STORMBYTE_DATABASE_PUBLIC Rows {
            public:
                using value_type = Row;                                                 
                using size_type = StormByte::Size;                                      
                using reference = Row&;                                                 
                using const_reference = const Row&;                                     
                using pointer = Row*;                                                   
                using const_pointer = const Row*;                                       
                using iterator = pointer;                                               
                using const_iterator = const_pointer;                                   
                using reverse_iterator = std::reverse_iterator<iterator>;               
                using const_reverse_iterator = std::reverse_iterator<const_iterator>;   
 
                Rows() noexcept;
 
                Rows(const Rows &other);
 
                Rows(Rows &&other) noexcept;
 
                ~Rows() noexcept;
 
                Rows &operator=(const Rows &other);
 
                Rows &operator=(Rows &&other) noexcept;
 
                bool operator==(const Rows &other) const;
 
                bool operator!=(const Rows &other) const;
 
                iterator begin() noexcept;
 
                const_iterator begin() const noexcept;
 
                iterator end() noexcept;
 
                const_iterator end() const noexcept;
 
                const_iterator cbegin() const noexcept;
 
                const_iterator cend() const noexcept;
 
                reverse_iterator rbegin() noexcept;
 
                reverse_iterator rend() noexcept;
 
                const_reverse_iterator rbegin() const noexcept;
 
                const_reverse_iterator rend() const noexcept;
 
                const_reverse_iterator crbegin() const noexcept;
 
                const_reverse_iterator crend() const noexcept;
 
                StormByte::Size size() const noexcept;
 
                bool empty() const noexcept;
 
                Row &operator[](StormByte::Size index);
 
                const Row &operator[](StormByte::Size index) const;
 
                void add(const Row &row);
 
                void add(Row &&row);
 
                bool has_item(const Row &row) const;
 
                StormByte::Size Count() const noexcept;
 
            private:
                struct ResultSet;
 
                std::unique_ptr<ResultSet> m_results;   
        };
    }
}