libkazv/api/range-t_8hpp_source.html

/*

 * This file is part of libkazv.

 * SPDX-FileCopyrightText: 2021 Tusooa Zhu <tusooa@kazv.moe>

 * SPDX-License-Identifier: AGPL-3.0-or-later

 */


#pragma once


static_assert(false, "This is an *interface*, not an actual class in the library.");


#include <cstddef>


template<class T>


class RangeT

{

public:

    using DataT = T;


    auto begin() const;


    auto end() const;


    const DataT &at(std::size_t index) const;


    const DataT &operator[](std::size_t index) const;

};


RangeT
A RangeT is an ordered collection that can be iterated through.
Definition range-t.hpp:21

RangeT::end
auto end() const
The past-end iterator of this range.

RangeT::at
const DataT & at(std::size_t index) const
Get the item at index with bound-checking.

RangeT::operator[]
const DataT & operator[](std::size_t index) const
Get the item at index without bound-checking.

RangeT::DataT
T DataT
The type of items in this range.
Definition range-t.hpp:24

RangeT::begin
auto begin() const
The beginning iterator of this range.