Row class for databases. More...

#include <row.hxx>

Classes
class	ConstIterator

class	Iterator
	Iterator class for Row. More...

Public Types
using	iterator = Iterator

using	const_iterator = ConstIterator

using	reverse_iterator = std::reverse_iterator< iterator >

using	const_reverse_iterator = std::reverse_iterator< const_iterator >

Public Member Functions
	Row () noexcept=default
	Default Constructor.

	Row (const Row &other)=default
	Copy Constructor.

	Row (Row &&other) noexcept=default
	Move Constructor.

	~Row () noexcept=default
	Destructor.

Row &	operator= (const Row &other)=default
	Copy Assignment Operator.

Row &	operator= (Row &&other) noexcept=default
	Move Assignment Operator.

const Value &	operator[] (std::size_t index) const &
	Gets the number of columns in the Row.

Value &	operator[] (std::size_t index) &
	Gets the value at the specified index.

Value	operator[] (std::size_t index) &&
	Gets the value at the specified index (rvalue)

const Value &	operator[] (const std::string &columnName) const &
	Gets the value for the specified column name.

Value &	operator[] (const std::string &columnName) &
	Gets the value for the specified column name.

Value	operator[] (const std::string &columnName) &&
	Gets the value for the specified column name (rvalue)

void	Add (std::string &&columnName, Value &&value)
	Adds a value to the Row.

iterator	begin () noexcept
	Gets begin iterator.

iterator	end () noexcept
	Gets end iterator.

const_iterator	begin () const noexcept
	Gets const begin iterator.

const_iterator	end () const noexcept
	Gets const end iterator.

const_iterator	cbegin () const noexcept
	Gets const begin iterator.

const_iterator	cend () const noexcept
	Gets const end iterator.

reverse_iterator	rbegin () noexcept
	Gets reverse begin iterator.

reverse_iterator	rend () noexcept
	Gets reverse end iterator.

const_reverse_iterator	rbegin () const noexcept
	Gets const reverse begin iterator.

const_reverse_iterator	rend () const noexcept
	Gets const reverse end iterator.

std::size_t	Count () const noexcept
	Gets number of columns in the Row.

Detailed Description

Row class for databases.

Constructor & Destructor Documentation

◆ Row() [1/2]

StormByte::Database::Row::Row ( const Row & other )

default

Copy Constructor.

Parameters

other Other Row to copy from

◆ Row() [2/2]

StormByte::Database::Row::Row ( Row && other )

defaultnoexcept

Move Constructor.

Parameters

other Other Row to move from

Member Function Documentation

◆ Add()

void StormByte::Database::Row::Add	(	std::string &&	columnName,
		Value &&	value
	)

inline

Adds a value to the Row.

Parameters

columnName	Optional name of the column
value	Value to add

◆ begin() [1/2]

const_iterator StormByte::Database::Row::begin ( ) const

inlinenoexcept

Gets const begin iterator.

Returns: ConstIterator to the first element

◆ begin() [2/2]

iterator StormByte::Database::Row::begin ( )

inlinenoexcept

Gets begin iterator.

Returns: Iterator to the first element

◆ cbegin()

const_iterator StormByte::Database::Row::cbegin ( ) const

inlinenoexcept

Gets const begin iterator.

Returns: ConstIterator to the first element

◆ cend()

const_iterator StormByte::Database::Row::cend ( ) const

inlinenoexcept

Gets const end iterator.

Returns: ConstIterator to past the last element

◆ Count()

std::size_t StormByte::Database::Row::Count ( ) const

inlinenoexcept

Gets number of columns in the Row.

Returns: Number of columns in the Row

◆ end() [1/2]

const_iterator StormByte::Database::Row::end ( ) const

inlinenoexcept

Gets const end iterator.

Returns: ConstIterator to past the last element

◆ end() [2/2]

iterator StormByte::Database::Row::end ( )

inlinenoexcept

Gets end iterator.

Returns: Iterator to past the last element

◆ operator=() [1/2]

Row & StormByte::Database::Row::operator= ( const Row & other )

default

Copy Assignment Operator.

Parameters

other Other Row to copy from

Returns: Reference to this Row

◆ operator=() [2/2]

Row & StormByte::Database::Row::operator= ( Row && other )

defaultnoexcept

Move Assignment Operator.

Parameters

other Other Row to move from

Returns: Reference to this Row

◆ operator[]() [1/6]

Value & StormByte::Database::Row::operator[] ( const std::string & columnName ) &

Gets the value for the specified column name.

Parameters

columnName Name of the column

Returns: Reference to the Value for the specified column name

Exceptions

ColumnNotFound if the column name does not exist

◆ operator[]() [2/6]

Value StormByte::Database::Row::operator[] ( const std::string & columnName ) &&

Gets the value for the specified column name (rvalue)

Parameters

columnName Name of the column

Returns: Value for the specified column name

Exceptions

ColumnNotFound if the column name does not exist

◆ operator[]() [3/6]

const Value & StormByte::Database::Row::operator[] ( const std::string & columnName ) const &

Gets the value for the specified column name.

Parameters

columnName Name of the column

Returns: Reference to the Value for the specified column name

Exceptions

ColumnNotFound if the column name does not exist

◆ operator[]() [4/6]

Value & StormByte::Database::Row::operator[] ( std::size_t index ) &

Gets the value at the specified index.

Parameters

index Index of the value to retrieve

Returns: Reference to the Value at the specified index

Exceptions

OutOfBounds if index is out of bounds

◆ operator[]() [5/6]

Value StormByte::Database::Row::operator[] ( std::size_t index ) &&

Gets the value at the specified index (rvalue)

Parameters

index Index of the value to retrieve

Returns: Value at the specified index

Exceptions

OutOfBounds if index is out of bounds

◆ operator[]() [6/6]

const Value & StormByte::Database::Row::operator[] ( std::size_t index ) const &

Gets the number of columns in the Row.

Parameters

index Index of the value to retrieve

Returns: Number of columns

Exceptions

OutOfBounds if index is out of bounds

◆ rbegin() [1/2]

const_reverse_iterator StormByte::Database::Row::rbegin ( ) const

inlinenoexcept

Gets const reverse begin iterator.

Returns: Const reverse iterator to the last element

◆ rbegin() [2/2]

reverse_iterator StormByte::Database::Row::rbegin ( )

inlinenoexcept

Gets reverse begin iterator.

Returns: Reverse iterator to the last element

◆ rend() [1/2]

const_reverse_iterator StormByte::Database::Row::rend ( ) const

inlinenoexcept

Gets const reverse end iterator.

Returns: Const reverse iterator to before the first element

◆ rend() [2/2]

reverse_iterator StormByte::Database::Row::rend ( )

inlinenoexcept

Gets reverse end iterator.

Returns: Reverse iterator to before the first element

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

/home/runner/work/StormByte-Database/StormByte-Database/lib/public/StormByte/database/row.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Row() [1/2]

◆ Row() [2/2]

Member Function Documentation

◆ Add()

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ Count()

◆ end() [1/2]

◆ end() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/6]

◆ operator[]() [2/6]

◆ operator[]() [3/6]

◆ operator[]() [4/6]

◆ operator[]() [5/6]

◆ operator[]() [6/6]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]