azure-core
Public Member Functions | Static Public Attributes | List of all members
Azure::Core::OperationStatus Class Referencefinal

Long-running operation states.

#include <operation_status.hpp>

Public Member Functions

 OperationStatus (const std::string &value)
 Constructs an OperationStatus with value. More...
 
 OperationStatus (std::string &&value)
 Constructs an OperationStatus with value. More...
 
 OperationStatus (const char *value)
 Constructs an OperationStatus with value. More...
 
bool operator== (const OperationStatus &other) const noexcept
 Compares two OperationStatus objects for equality. More...
 
bool operator!= (const OperationStatus &other) const noexcept
 Compares two OperationStatus objects for equality. More...
 
const std::string & Get () const noexcept
 Gets the std::string representation of the operation status.
 

Static Public Attributes

static AZ_CORE_DLLEXPORT const OperationStatus NotStarted
 The Azure::Core::Operation is Not Started.
 
static AZ_CORE_DLLEXPORT const OperationStatus Running {"Running"}
 The Azure::Core::Operation is Running.
 
static AZ_CORE_DLLEXPORT const OperationStatus Succeeded {"Succeeded"}
 The Azure::Core::Operation Succeeded.
 
static AZ_CORE_DLLEXPORT const OperationStatus Cancelled {"Cancelled"}
 The Azure::Core::Operation was Cancelled.
 
static AZ_CORE_DLLEXPORT const OperationStatus Failed {"Failed"}
 The Azure::Core::Operation Failed.
 

Constructor & Destructor Documentation

◆ OperationStatus() [1/3]

Azure::Core::OperationStatus::OperationStatus ( const std::string &  value)
inlineexplicit
Parameters
valueThe value to initialize with.

◆ OperationStatus() [2/3]

Azure::Core::OperationStatus::OperationStatus ( std::string &&  value)
inlineexplicit
Parameters
valueThe value to initialize with.

◆ OperationStatus() [3/3]

Azure::Core::OperationStatus::OperationStatus ( const char *  value)
inlineexplicit
Parameters
valueThe value to initialize with.

Member Function Documentation

◆ operator!=()

bool Azure::Core::OperationStatus::operator!= ( const OperationStatus other) const
inlinenoexcept
Parameters
otherA OperationStatus to compare with.
Returns
false if the states have the same string representation; otherwise, true.

◆ operator==()

bool Azure::Core::OperationStatus::operator== ( const OperationStatus other) const
inlinenoexcept
Parameters
otherAn OperationStatus to compare with.
Returns
true if the states have the same string representation; otherwise,false.

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