class error_code

Declaration

class error_code : public std::error_code { /* full declaration omitted */ };

Description

A pika::error_code represents an arbitrary error condition.

//////////////////////////////////////////////////////////////////////// The class pika::error_code describes an object used to hold error code values, such as those originating from the operating system or other low-level application program interfaces.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:80

Inherits from: std::error_code

Method Overview

public void clear()
public error_code(pika::throwmode mode = plain)
public error_code(pika::error e, pika::throwmode mode = plain)
public error_code(pika::error e, const char * func, const char * file, long line, pika::throwmode mode = plain)
public error_code(pika::error e, const char * msg, pika::throwmode mode = plain)
public error_code(pika::error e, const char * msg, const char * func, const char * file, long line, pika::throwmode mode = plain)
public error_code(pika::error e, const std::string & msg, pika::throwmode mode = plain)
public error_code(pika::error e, const std::string & msg, const char * func, const char * file, long line, pika::throwmode mode = plain)
public error_code(const pika::error_code & rhs)
public std::string get_message() const

Methods

void clear()

Description

Clear this error_code object. The postconditions of invoking this method are * value() == pika::success and category() == pika::get_pika_category()

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:213

error_code(pika::throwmode mode = plain)

Description

Construct an object of type error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:92

Parameters

pika::throwmode mode = plain: The parameter \pspecifies whether the constructed pika::error_code belongs to the error category\a(if mode is \athis is the default) or to the category \a(if mode is \a

error_code(pika::error e,
           pika::throwmode mode = plain)

Description

Construct an object of type error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:108

Parameters

pika::error e: The parameter \pholds the pika::error code the new exception should encapsulate.
pika::throwmode mode = plain: The parameter \pspecifies whether the constructed pika::error_code belongs to the error category\a(if mode is \athis is the default) or to the category \a(if mode is \a

error_code(pika::error e,
           const char* func,
           const char* file,
           long line,
           pika::throwmode mode = plain)

Description

Construct an object of type error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:125

Parameters

pika::error e: The parameter \pholds the pika::error code the new exception should encapsulate.
const char* func: The name of the function where the error was raised.
const char* file: The file name of the code where the error was raised.
long line: The line number of the code line where the error was raised.
pika::throwmode mode = plain: The parameter \pspecifies whether the constructed pika::error_code belongs to the error category\a(if mode is \athis is the default) or to the category \a(if mode is \a

error_code(pika::error e,
           const char* msg,
           pika::throwmode mode = plain)

Description

Construct an object of type error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:142

Parameters

pika::error e: The parameter \pholds the pika::error code the new exception should encapsulate.
const char* msg: The parameter \pholds the error message the new exception should encapsulate.
pika::throwmode mode = plain: The parameter \pspecifies whether the constructed pika::error_code belongs to the error category\a(if mode is \athis is the default) or to the category \a(if mode is \a

error_code(pika::error e,
           const char* msg,
           const char* func,
           const char* file,
           long line,
           pika::throwmode mode = plain)

Description

Construct an object of type error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:163

Parameters

pika::error e: The parameter \pholds the pika::error code the new exception should encapsulate.
const char* msg: The parameter \pholds the error message the new exception should encapsulate.
const char* func: The name of the function where the error was raised.
const char* file: The file name of the code where the error was raised.
long line: The line number of the code line where the error was raised.
pika::throwmode mode = plain: The parameter \pspecifies whether the constructed pika::error_code belongs to the error category\a(if mode is \athis is the default) or to the category \a(if mode is \a

error_code(pika::error e,
           const std::string& msg,
           pika::throwmode mode = plain)

Description

Construct an object of type error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:180

Parameters

pika::error e: The parameter \pholds the pika::error code the new exception should encapsulate.
const std::string& msg: The parameter \pholds the error message the new exception should encapsulate.
pika::throwmode mode = plain: The parameter \pspecifies whether the constructed pika::error_code belongs to the error category\a(if mode is \athis is the default) or to the category \a(if mode is \a

error_code(pika::error e,
           const std::string& msg,
           const char* func,
           const char* file,
           long line,
           pika::throwmode mode = plain)

Description

Construct an object of type error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:201

Parameters

pika::error e: The parameter \pholds the pika::error code the new exception should encapsulate.
const std::string& msg: The parameter \pholds the error message the new exception should encapsulate.
const char* func: The name of the function where the error was raised.
const char* file: The file name of the code where the error was raised.
long line: The line number of the code line where the error was raised.
pika::throwmode mode = plain: The parameter \pspecifies whether the constructed pika::error_code belongs to the error category\a(if mode is \athis is the default) or to the category \a(if mode is \a

error_code(const pika::error_code& rhs)

Description

Copy constructor for error_code

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:223

Parameters

const pika::error_code& rhs

std::string get_message() const

Description

Return a reference to the error message stored in the pika::error_code.

Declared at: libs/pika/errors/include/pika/errors/error_code.hpp:208