llfio_v2_xxx::error_info Struct Reference

The cause of the failure of an operation in LLFIO. More...

#include "status_code.hpp"

Public Member Functions
	error_info ()=default
	Default constructor.
	error_info (std::error_code _ec)
	OUTCOME_TEMPLATE (class ErrorCondEnum) OUTCOME_TREQUIRES(OUTCOME_TPRED(std
	Implicit construct from an error condition enum.
int	value () const noexcept
	Retrieve the value of the error code.
filesystem::path	path1 () const
filesystem::path	path2 () const
std::string	message () const
void	throw_exception () const

Friends
std::error_code	make_error_code (error_info ei)

Detailed Description

The cause of the failure of an operation in LLFIO.

Constructor & Destructor Documentation

error_info()

llfio_v2_xxx::error_info::error_info ( std::error_code  _ec )

inlineexplicit

    : ec(_ec)
{
// Here is a VERY useful place to breakpoint!
#ifndef LLFIO_DISABLE_PATHS_IN_FAILURE_INFO
  if(ec)
  {
    detail::fill_failure_info(*this, this->ec);
  }
#endif
}

Member Function Documentation

message()

std::string llfio_v2_xxx::error_info::message ( ) const

inline

Retrieve a descriptive message for this failure, possibly with paths and stack backtraces. Extra detail only appears if called from the same thread as where the failure occurred.

  {
    std::string ret(ec.message());
#if !LLFIO_DISABLE_PATHS_IN_FAILURE_INFO
    detail::append_path_info(*this, ret);
#endif
    return ret;
  }

OUTCOME_TEMPLATE()

llfio_v2_xxx::error_info::OUTCOME_TEMPLATE ( class ErrorCondEnum  )

inline

Implicit construct from an error condition enum.

      : error_info(make_error_code(std::forward<ErrorCondEnum>(v)))
  {
  }

path1()

filesystem::path llfio_v2_xxx::error_info::path1 ( ) const

inline

Retrieve any first path associated with this failure. Note this only works if called from the same thread as where the failure occurred.

  {
#if !LLFIO_DISABLE_PATHS_IN_FAILURE_INFO
    if(QUICKCPPLIB_NAMESPACE::utils::thread::this_thread_id() == _thread_id)
    {
      auto &tls = detail::tls_errored_results();
      const char *path1 = tls.get(_tls_path_id1);
      if(path1 != nullptr)
      {
        return filesystem::path(path1);
      }
    }
#endif
    return {};
  }

path2()

filesystem::path llfio_v2_xxx::error_info::path2 ( ) const

inline

Retrieve any second path associated with this failure. Note this only works if called from the same thread as where the failure occurred.

  {
#if !LLFIO_DISABLE_PATHS_IN_FAILURE_INFO
    if(QUICKCPPLIB_NAMESPACE::utils::thread::this_thread_id() == _thread_id)
    {
      auto &tls = detail::tls_errored_results();
      const char *path2 = tls.get(_tls_path_id2);
      if(path2 != nullptr)
      {
        return filesystem::path(path2);
      }
    }
#endif
    return {};
  }

throw_exception()

void llfio_v2_xxx::error_info::throw_exception ( ) const

inline

Throw this failure as a C++ exception. Firstly if the error code matches any of the standard C++ exception types e.g. bad_alloc, we throw those types using the string from message() where possible. We then will throw an error exception type.

{
  std::string msg;
  LLFIO_EXCEPTION_TRY
  {
    msg = message();
  }
  LLFIO_EXCEPTION_CATCH_ALL {}
#ifdef __cpp_exceptions
  OUTCOME_V2_NAMESPACE::try_throw_std_exception_from_error(ec, msg);
#endif
  LLFIO_EXCEPTION_THROW(error(*this));
}

value()

int llfio_v2_xxx::error_info::value ( ) const

inlinenoexcept

Retrieve the value of the error code.

{ return ec.value(); }

Friends And Related Symbol Documentation

make_error_code

std::error_code make_error_code ( error_info  ei )

friend

{
  return ei.ec;
}

---

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

• include/llfio/v2.0/status_code.hpp
• include/llfio/v2.0/handle.hpp