From efcea3a80da7c4479d5fe168435ecc9fd06bdc72 Mon Sep 17 00:00:00 2001 From: John Turner Date: Sun, 14 Sep 2025 00:16:10 -0400 Subject: Squashed 'subprojects/boost-sqlite/' content from commit 3378e35 git-subtree-dir: subprojects/boost-sqlite git-subtree-split: 3378e353705271e569cf4ba15c467b840a39798c --- doc/reference/row.adoc | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 doc/reference/row.adoc (limited to 'doc/reference/row.adoc') diff --git a/doc/reference/row.adoc b/doc/reference/row.adoc new file mode 100644 index 0000000..d3af982 --- /dev/null +++ b/doc/reference/row.adoc @@ -0,0 +1,56 @@ +== `sqlite/row.hpp` + +This type represents one row of data from a query. Is a random-access range. + +WARNING: This type is a pure view type, and will be invalidated when the next row is read. + + + +[source,cpp] +---- + +struct row +{ + // The size of the row, i.e. number of colums + std::size_t size() const; + + // Returns the field at `idx`, @throws std::out_of_range + field at(std::size_t idx) const; + // Returns the field at `idx`. + field operator[](std::size_t idx) const; + + // Random access iterator used to iterate over the columns. + struct const_iterator + { + using difference_type = int; + using reference = field&; + using iterator_category = std::random_access_iterator_tag; + + const_iterator & operator++(); + const_iterator operator++(int); + const_iterator & operator--(); + const_iterator operator--(int); + + field operator[](int i) const; + + const_iterator operator+(int i) const; + const_iterator operator-(int i) const; + const_iterator & operator+=(int i); + const_iterator & operator-=(int i); + const field & operator*() const; + const field * operator->() const; + + bool operator==(const const_iterator& other) const; + bool operator!=(const const_iterator& other) const; + bool operator<(const const_iterator& other) const; + bool operator>(const const_iterator& other) const; + + const_iterator() = default; + }; + // Returns the begin of the column-range. + const_iterator begin() const; + + // Returns the end of the column-range. + const_iterator end() const +}; +---- -- cgit v1.2.3