audacity::sqlite::Result< T > Class Template Reference

A class representing a result of an operation. More...

#include <Result.h>

Public Member Functions
	Result ()=default
	Result (T &&value) noexcept(std::is_nothrow_move_constructible_v< T >)
	Result (const Error &error) noexcept(std::is_nothrow_copy_constructible_v< Error >)
	Result (Error &&error) noexcept(std::is_nothrow_move_constructible_v< Error >)
bool	HasValue () const noexcept
T &	operator* () &
const T &	operator* () const &
T *	operator-> ()
const T *	operator-> () const
T &&	operator* () &&
	operator bool () const noexcept
Error	GetError () const noexcept

Private Attributes
std::variant< Error, T >	mValue

Detailed Description

template<typename T>
class audacity::sqlite::Result< T >

A class representing a result of an operation.

Definition at line 18 of file Result.h.

Constructor & Destructor Documentation

Result() [1/4]

template<typename T >

audacity::sqlite::Result< T >::Result ( )

default

Result() [2/4]

template<typename T >

audacity::sqlite::Result< T >::Result ( T &&  value )

inlinenoexcept

Definition at line 23 of file Result.h.

      : mValue (std::forward<T>(value))
   {
   }

Result() [3/4]

template<typename T >

audacity::sqlite::Result< T >::Result ( const Error &  error )

inlinenoexcept

Definition at line 28 of file Result.h.

      : mValue (error)
   {
   }

Result() [4/4]

template<typename T >

audacity::sqlite::Result< T >::Result ( Error &&  error )

inlinenoexcept

Definition at line 33 of file Result.h.

      : mValue (std::move(error))
   {
   }

Member Function Documentation

GetError()

template<typename T >

Error audacity::sqlite::Result< T >::GetError ( ) const

inlinenoexcept

Definition at line 79 of file Result.h.

   {
      if (HasValue())
         return Error();
 
      return *std::get_if<Error>(&mValue);
   }

References audacity::sqlite::Result< T >::HasValue(), and audacity::sqlite::Result< T >::mValue.

Here is the call graph for this function:

HasValue()

template<typename T >

bool audacity::sqlite::Result< T >::HasValue ( ) const

inlinenoexcept

Definition at line 38 of file Result.h.

   {
      return std::holds_alternative<T>(mValue);
   }

References audacity::sqlite::Result< T >::mValue.

Referenced by audacity::sqlite::Result< T >::GetError(), audacity::sqlite::Result< T >::operator bool(), and audacity::sqlite::Result< T >::operator*().

Here is the caller graph for this function:

operator bool()

template<typename T >

audacity::sqlite::Result< T >::operator bool ( ) const

inlineexplicitnoexcept

Definition at line 74 of file Result.h.

   {
      return HasValue();
   }

References audacity::sqlite::Result< T >::HasValue().

Here is the call graph for this function:

operator*() [1/3]

template<typename T >

T & audacity::sqlite::Result< T >::operator* ( ) &

inline

Definition at line 43 of file Result.h.

   {
      if (!HasValue())
         std::get_if<Error>(&mValue)->Raise();
 
      return *std::get_if<T>(&mValue);
   }

References audacity::sqlite::Result< T >::HasValue(), and audacity::sqlite::Result< T >::mValue.

Referenced by audacity::sqlite::Result< T >::operator->().

Here is the call graph for this function:

Here is the caller graph for this function:

operator*() [2/3]

template<typename T >

T && audacity::sqlite::Result< T >::operator* ( ) &&

inline

Definition at line 66 of file Result.h.

   {
      if (!HasValue())
         std::get_if<Error>(&mValue)->Raise();
 
      return std::move(*std::get_if<T>(&mValue));
   }

References audacity::sqlite::Result< T >::HasValue(), and audacity::sqlite::Result< T >::mValue.

Here is the call graph for this function:

operator*() [3/3]

template<typename T >

const T & audacity::sqlite::Result< T >::operator* ( ) const &

inline

Definition at line 51 of file Result.h.

   {
      return const_cast<Result*>(this)->operator*();
   }

operator->() [1/2]

template<typename T >

T * audacity::sqlite::Result< T >::operator-> ( )

inline

Definition at line 56 of file Result.h.

   {
      return &operator*();
   }

References audacity::sqlite::Result< T >::operator*().

Here is the call graph for this function:

operator->() [2/2]

template<typename T >

const T * audacity::sqlite::Result< T >::operator-> ( ) const

inline

Definition at line 61 of file Result.h.

   {
      return &operator*();
   }

References audacity::sqlite::Result< T >::operator*().

Here is the call graph for this function:

Member Data Documentation

mValue

template<typename T >

std::variant<Error, T> audacity::sqlite::Result< T >::mValue

private

Definition at line 87 of file Result.h.

Referenced by audacity::sqlite::Result< T >::GetError(), audacity::sqlite::Result< T >::HasValue(), and audacity::sqlite::Result< T >::operator*().

---

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

• Result.h