audacity::sqlite::RowIterator Class Reference

A class representing an iterator over a result set. More...

#include <Statement.h>

Collaboration diagram for audacity::sqlite::RowIterator:

Public Member Functions
	RowIterator (const RowIterator &)=delete
	RowIterator (RowIterator &&) noexcept
RowIterator &	operator= (const RowIterator &)=delete
RowIterator &	operator= (RowIterator &&) noexcept
RowIterator &	operator++ () noexcept
bool	operator== (const RowIterator &other) const noexcept
bool	operator!= (const RowIterator &other) const noexcept
Row	operator* () const noexcept

Private Member Functions
	RowIterator (StatementHandlePtr statement, std::vector< Error > &errors) noexcept
	RowIterator () noexcept

Private Attributes
StatementHandlePtr	mStatement {}
std::vector< Error > *	mErrors {}
int	mRowIndex { 0 }
bool	mDone { false }

Friends
class	RunResult

Detailed Description

A class representing an iterator over a result set.

Definition at line 68 of file Statement.h.

Constructor & Destructor Documentation

RowIterator() [1/4]

audacity::sqlite::RowIterator::RowIterator ( StatementHandlePtr  statement, std::vector< Error > &  errors  )

privatenoexcept

Definition at line 272 of file Statement.cpp.

    : mStatement { std::move(stmt) }
    , mErrors { &errors }
{
   // mStatement can't be nullptr here, by construction
   assert(mStatement != nullptr);
}

RowIterator() [2/4]

audacity::sqlite::RowIterator::RowIterator ( )

privatenoexcept

Definition at line 280 of file Statement.cpp.

    : mDone { true }
{
}

RowIterator() [3/4]

audacity::sqlite::RowIterator::RowIterator ( const RowIterator &  )

delete

RowIterator() [4/4]

audacity::sqlite::RowIterator::RowIterator ( RowIterator &&  rhs )

noexcept

Definition at line 285 of file Statement.cpp.

{
   *this = std::move(rhs);
}

Member Function Documentation

operator!=()

bool audacity::sqlite::RowIterator::operator!= ( const RowIterator &  other ) const

noexcept

Definition at line 330 of file Statement.cpp.

{
   return !(*this == rhs);
}

operator*()

Row audacity::sqlite::RowIterator::operator* ( ) const

noexcept

Definition at line 335 of file Statement.cpp.

{
   return Row { mStatement, *mErrors };
}

References mErrors, and mStatement.

operator++()

RowIterator & audacity::sqlite::RowIterator::operator++ ( )

noexcept

Definition at line 299 of file Statement.cpp.

{
   if (mStatement == nullptr || mDone)
      return *this;
 
   const auto rc = sqlite3_step(*mStatement);
 
   if (rc == SQLITE_ROW)
      ++mRowIndex;
   else
   {
      mDone = true;
 
      if (rc != SQLITE_DONE)
         mErrors->emplace_back(Error(rc));
   }
 
   return *this;
}

References mDone, mErrors, mRowIndex, and mStatement.

operator=() [1/2]

RowIterator & audacity::sqlite::RowIterator::operator= ( const RowIterator &  )

delete

operator=() [2/2]

RowIterator & audacity::sqlite::RowIterator::operator= ( RowIterator &&  rhs )

noexcept

Definition at line 290 of file Statement.cpp.

{
   std::swap(mStatement, rhs.mStatement);
   std::swap(mErrors, rhs.mErrors);
   std::swap(mRowIndex, rhs.mRowIndex);
   std::swap(mDone, rhs.mDone);
   return *this;
}

References anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

operator==()

bool audacity::sqlite::RowIterator::operator== ( const RowIterator &  other ) const

noexcept

Definition at line 319 of file Statement.cpp.

{
   if (mDone != rhs.mDone)
      return false;
 
   if (mDone)
      return true;
 
   return mStatement == rhs.mStatement && mRowIndex == rhs.mRowIndex;
}

Friends And Related Function Documentation

RunResult

friend class RunResult

friend

Definition at line 70 of file Statement.h.

Member Data Documentation

mDone

bool audacity::sqlite::RowIterator::mDone { false }

private

Definition at line 94 of file Statement.h.

Referenced by operator++().

mErrors

std::vector<Error>* audacity::sqlite::RowIterator::mErrors {}

private

Definition at line 91 of file Statement.h.

Referenced by operator*(), and operator++().

mRowIndex

int audacity::sqlite::RowIterator::mRowIndex { 0 }

private

Definition at line 93 of file Statement.h.

Referenced by operator++().

mStatement

StatementHandlePtr audacity::sqlite::RowIterator::mStatement {}

private

Definition at line 90 of file Statement.h.

Referenced by operator*(), and operator++().

---

The documentation for this class was generated from the following files:

• Statement.h
• Statement.cpp