MySQL 8.4.3
Source Code Documentation
Ha_trx_info_list Class Reference

Container to hold and allow iteration over a set of Ha_trx_info objects. More...

#include <transaction_info.h>

Classes

class  Iterator
 Implements a forward iterator for Ha_trx_info_list. More...
 

Public Member Functions

 Ha_trx_info_list ()=default
 Default constructor. More...
 
 Ha_trx_info_list (Ha_trx_info *rhs)
 Class constructor that instantiates the underlying head of the list with the parameter. More...
 
 Ha_trx_info_list (Ha_trx_info_list const &rhs)
 Copy constructor. More...
 
 Ha_trx_info_list (Ha_trx_info_list &&rhs)
 Move constructor. More...
 
virtual ~Ha_trx_info_list ()=default
 
Ha_trx_info_listoperator= (Ha_trx_info_list const &rhs)
 Copy operator. More...
 
Ha_trx_info_listoperator= (Ha_trx_info_list &&rhs)
 Move operator. More...
 
Ha_trx_infooperator* ()
 Retrieves the reference to the undelying head of the list. More...
 
Ha_trx_info const & operator* () const
 Retrieves the reference to the undelying head of the list. More...
 
Ha_trx_infooperator-> ()
 Retrieves the pointer to the undelying head of the list. More...
 
Ha_trx_info const * operator-> () const
 Retrieves the pointer to the undelying head of the list. More...
 
bool operator== (Ha_trx_info_list const &rhs) const
 Equality operator that compares with another instance of this class. More...
 
bool operator== (Ha_trx_info const *rhs) const
 Equality operator that compares with an instance of Ha_trx_info class. More...
 
bool operator== (std::nullptr_t rhs) const
 Equality operator that compares with null. More...
 
bool operator!= (Ha_trx_info_list const &rhs) const
 Inequality operator that compares with another instance of this class. More...
 
bool operator!= (Ha_trx_info const *rhs) const
 Inequality operator that compares with an instance of Ha_trx_info class. More...
 
bool operator!= (std::nullptr_t rhs) const
 Inequality operator that compares with null. More...
 
 operator bool () const
 Cast operator to bool. More...
 
Ha_trx_infohead ()
 Retrieves the pointer to the underlying list head. More...
 
Iterator begin ()
 Retrieves an iterator pointing to the underlying list head. More...
 
const Iterator begin () const
 Retrieves an iterator pointing to the underlying list head. More...
 
Iterator end ()
 Retrieves an iterator pointing to null. More...
 
const Iterator end () const
 Retrieves an iterator pointing to null. More...
 

Private Attributes

Ha_trx_infom_underlying {nullptr}
 The head of the list. More...
 

Detailed Description

Container to hold and allow iteration over a set of Ha_trx_info objects.

Constructor & Destructor Documentation

◆ Ha_trx_info_list() [1/4]

Ha_trx_info_list::Ha_trx_info_list ( )
default

Default constructor.

◆ Ha_trx_info_list() [2/4]

Ha_trx_info_list::Ha_trx_info_list ( Ha_trx_info rhs)

Class constructor that instantiates the underlying head of the list with the parameter.

Parameters
rhsThe pointer to initialize the underlying list head with.

◆ Ha_trx_info_list() [3/4]

Ha_trx_info_list::Ha_trx_info_list ( Ha_trx_info_list const &  rhs)

Copy constructor.

Parameters
rhsThe object instance to copy content from.

◆ Ha_trx_info_list() [4/4]

Ha_trx_info_list::Ha_trx_info_list ( Ha_trx_info_list &&  rhs)

Move constructor.

Parameters
rhsThe object instance to move content from.

◆ ~Ha_trx_info_list()

virtual Ha_trx_info_list::~Ha_trx_info_list ( )
virtualdefault

Member Function Documentation

◆ begin() [1/2]

Ha_trx_info_list::Iterator Ha_trx_info_list::begin ( void  )

Retrieves an iterator pointing to the underlying list head.

Returns
An iterator pointing to the underlying list head.

◆ begin() [2/2]

const Ha_trx_info_list::Iterator Ha_trx_info_list::begin ( void  ) const

Retrieves an iterator pointing to the underlying list head.

Returns
An iterator pointing to the underlying list head.

◆ end() [1/2]

Ha_trx_info_list::Iterator Ha_trx_info_list::end ( void  )

Retrieves an iterator pointing to null.

Returns
An iterator pointing null.

◆ end() [2/2]

const Ha_trx_info_list::Iterator Ha_trx_info_list::end ( void  ) const

Retrieves an iterator pointing to null.

Returns
An iterator pointing null.

◆ head()

Ha_trx_info * Ha_trx_info_list::head ( )

Retrieves the pointer to the underlying list head.

Returns
The underlying list head.

◆ operator bool()

Ha_trx_info_list::operator bool ( ) const

Cast operator to bool.

It returns true if the this object underlying list head doesn't point to null, false otherwise.

Returns
true if the this object underlying list head doesn't point to null, false otherwise.

◆ operator!=() [1/3]

bool Ha_trx_info_list::operator!= ( Ha_trx_info const *  rhs) const

Inequality operator that compares with an instance of Ha_trx_info class.

It evaluates to true if this object's underlying head points to a different address of the parameter object.

Parameters
rhsThe object to compare this object to.
Returns
true if this object's underlying head point to different address as the parameter object, false otherwise.

◆ operator!=() [2/3]

bool Ha_trx_info_list::operator!= ( Ha_trx_info_list const &  rhs) const

Inequality operator that compares with another instance of this class.

It evaluates to true if both object's underlying head point to the different addresses.

Parameters
rhsThe object to compare this object to.
Returns
true if both object's underlying head point to different addresses, false otherwise.

◆ operator!=() [3/3]

bool Ha_trx_info_list::operator!= ( std::nullptr_t  rhs) const

Inequality operator that compares with null.

It evaluates to true if this object's underlying head points to a non-null value.

Parameters
rhsThe nullptr value
Returns
true if this object's underlying head point to a non-null value, false otherwise.

◆ operator*() [1/2]

Ha_trx_info & Ha_trx_info_list::operator* ( )

Retrieves the reference to the undelying head of the list.

Returns
The reference to the undelying head of the list.

◆ operator*() [2/2]

Ha_trx_info const & Ha_trx_info_list::operator* ( ) const

Retrieves the reference to the undelying head of the list.

Returns
The reference to the undelying head of the list.

◆ operator->() [1/2]

Ha_trx_info * Ha_trx_info_list::operator-> ( )

Retrieves the pointer to the undelying head of the list.

Returns
The pointer to the undelying head of the list.

◆ operator->() [2/2]

Ha_trx_info const * Ha_trx_info_list::operator-> ( ) const

Retrieves the pointer to the undelying head of the list.

Returns
The pointer to the undelying head of the list.

◆ operator=() [1/2]

Ha_trx_info_list & Ha_trx_info_list::operator= ( Ha_trx_info_list &&  rhs)

Move operator.

Parameters
rhsThe object instance to move content from.
Returns
this object reference, for chaining puposes.

◆ operator=() [2/2]

Ha_trx_info_list & Ha_trx_info_list::operator= ( Ha_trx_info_list const &  rhs)

Copy operator.

Parameters
rhsThe object instance to copy content from.
Returns
this object reference, for chaining puposes.

◆ operator==() [1/3]

bool Ha_trx_info_list::operator== ( Ha_trx_info const *  rhs) const

Equality operator that compares with an instance of Ha_trx_info class.

It evaluates to true if this object's underlying head points to the same address of the parameter object.

Parameters
rhsThe object to compare this object to.
Returns
true if this object's underlying head point to the same address as the parameter object, false otherwise.

◆ operator==() [2/3]

bool Ha_trx_info_list::operator== ( Ha_trx_info_list const &  rhs) const

Equality operator that compares with another instance of this class.

It evaluates to true if both object's underlying head point to the same address.

Parameters
rhsThe object to compare this object to.
Returns
true if both object's underlying head point to the same address, false otherwise.

◆ operator==() [3/3]

bool Ha_trx_info_list::operator== ( std::nullptr_t  rhs) const

Equality operator that compares with null.

It evaluates to true if this object's underlying head points to null.

Parameters
rhsThe nullptr value
Returns
true if this object's underlying head point to null, false otherwise.

Member Data Documentation

◆ m_underlying

Ha_trx_info* Ha_trx_info_list::m_underlying {nullptr}
private

The head of the list.


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