cuddl::Error Struct Reference

Error payload carried in Result on failure. More...

#include <error.hpp>

Public Member Functions
ErrorCategory	category () const noexcept
const std::string &	message () const noexcept
const CudaError *	as_cuda () const noexcept
const InvalidArgumentError *	as_invalid_argument () const noexcept
const ResourceError *	as_resource () const noexcept

Static Public Member Functions
static Error	cuda (cudaError_t code, std::source_location location=std::source_location::current())
static Error	invalid_argument (std::string message)
static Error	resource (std::string message)

Public Attributes
std::variant< CudaError, InvalidArgumentError, ResourceError >	kind

Detailed Description

Error payload carried in Result on failure.

Definition at line 64 of file error.hpp.

Member Function Documentation

as_cuda()

const CudaError * cuddl::Error::as_cuda ( ) const

inlinenoexcept

Definition at line 77 of file error.hpp.

                                                            {
        return std::get_if<CudaError>(&kind);
    }

as_invalid_argument()

const InvalidArgumentError * cuddl::Error::as_invalid_argument ( ) const

inlinenoexcept

Definition at line 81 of file error.hpp.

                                                                                   {
        return std::get_if<InvalidArgumentError>(&kind);
    }

as_resource()

const ResourceError * cuddl::Error::as_resource ( ) const

inlinenoexcept

Definition at line 85 of file error.hpp.

                                                                    {
        return std::get_if<ResourceError>(&kind);
    }

category()

ErrorCategory cuddl::Error::category ( ) const

inlinenoexcept

Definition at line 67 of file error.hpp.

                                                          {
        return static_cast<ErrorCategory>(kind.index());
    }

cuda()

static Error cuddl::Error::cuda ( cudaError_t  code, std::source_location  location = std::source_location::current()  )

inlinestatic

Definition at line 90 of file error.hpp.

                                                                                      {
        const SourceLocation site = SourceLocation::from(location);
        return Error{CudaError{
            code,
            site,
            std::format("{}: {}", site.to_string(), cudaGetErrorString(code)),
        }};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

invalid_argument()

static Error cuddl::Error::invalid_argument ( std::string  message )

inlinestatic

Definition at line 99 of file error.hpp.

                                                                   {
        return Error{InvalidArgumentError{std::move(message)}};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

message()

const std::string & cuddl::Error::message ( ) const

inlinenoexcept

Definition at line 71 of file error.hpp.

                                                            {
        return std::visit(
            [](const auto& error) -> const std::string& { return error.message; }, kind
        );
    }

Here is the caller graph for this function:

resource()

static Error cuddl::Error::resource ( std::string  message )

inlinestatic

Definition at line 103 of file error.hpp.

                                                           {
        return Error{ResourceError{std::move(message)}};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

kind

std::variant<CudaError, InvalidArgumentError, ResourceError> cuddl::Error::kind

Definition at line 65 of file error.hpp.

---

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

• error.hpp