自定义 std::error_code

当我们函数的返回值是一个结果信息时,结果可能是成功也可能失败,如果是失败有时还需要带有失败信息,此时我们可以自行定义一个结构数据,也可是借助std::error_code。

第一步 定义一个错误种类枚举

enum class eArmErrorType {
  OK = 0,
  CREATE_TCP_CTX_FAILED,
  SLAVE_INVALID,
  CONNECT_FAILED,
  SET_TIMEOUT_FAILED
};

第二部 派生一个std::error_category

class ArmErrorCategory : public std::error_category {
 public:
  ArmErrorCategory() {}
  const char* name() const noexcept override {
    return "arm error";
  }
  std::string message(int ev) const override;
};

第三步 声明(或者说是注册,启用)称error_code枚举,本质就是模板特化

namespace std {
template <>
struct is_error_code_enum<eArmErrorType> : public true_type {};

第四步 重载make_error_code

std::error_code make_error_code(eArmErrorType e);


完整代码 ,注意注释部分

  • arm_err.h:
 #ifndef SRC_DRIVES_ARM_ARM_ERR_H_
#define SRC_DRIVES_ARM_ARM_ERR_H_
#include <string>
#include <system_error>

/*这是机械臂连接过程的错误类型枚举,OK代表没有异常,其他表示有异常*/
enum class eArmErrorType {
  OK = 0,
  CREATE_TCP_CTX_FAILED,
  SLAVE_INVALID,
  CONNECT_FAILED,
  SET_TIMEOUT_FAILED
};

/*构造std::error_code时需要提供我们自定义的枚举种类 (std::error_category),
有两个override函数,这两个函数纯虚函数*/
class ArmErrorCategory : public std::error_category {
 public:
  ArmErrorCategory() {}
  const char* name() const noexcept override {
    return "arm error";
  }
  std::string message(int ev) const override;
};

/* 需要提供一个全局的错误种类对象。作为参数传给std::error_code,
在std::error_code只记录了category的地址,所以要注意生命周期,
你也可以通过单例等方式提供 */
const ArmErrorCategory& arm_error_category();

/*为了方便的使用error_code(_ErrorCodeEnum __e)构造,需要重载make_error_code(eArmErrorType e),
如果不这样也可以每次直接使用error_code(static_cast<int>(__e), arm_error_category())来构造你的error_code*/
std::error_code make_error_code(eArmErrorType e);

/* 这是关键步骤,特化你的错误类型枚举,相当于是把他声明称error_code枚举*/
namespace std {
template <>
struct is_error_code_enum<eArmErrorType> : public true_type {};
}  // namespace std
#endif  // SRC_DRIVES_ARM_ARM_ERR_H_

arn_arr.cpp

#include "arm_err.h"

// 全局的错误种类对象
const ArmErrorCategory category{};

const ArmErrorCategory& arm_error_category() { return category; }

std::error_code make_error_code(eArmErrorType e) {
  return {static_cast<int>(e), arm_error_category()};
}

// 根据类型返回错误信息
std::string ArmErrorCategory::message(int ev) const{
  switch (static_cast<eArmErrorType>(ev)) {
    case eArmErrorType::OK:
      return "no error";
      break;
    case eArmErrorType::CREATE_TCP_CTX_FAILED:
      return "create a libmodbus context for TCP/IPv4 failed";
      break;
    case eArmErrorType::SLAVE_INVALID:
      return "The slave number is invalid";
      break;
    case eArmErrorType::CONNECT_FAILED:
      return "establish a Modbus connection failed";
      break;
    case eArmErrorType::SET_TIMEOUT_FAILED:
      return "set timeout for response failed";
      break;

    default:
      break;
  }

  return "unknown error";
}

使用

auto fun(){
    return std::error_code(eArmErrorType::CONNECT_FAILED);
}

缺点

错误信息为静态信息,如果需要动态变化时不太友好,全局共享一个category如果在其中设置错误信息变量还需要考虑线程安全性。比如我使用modbus进行tcp连接,此时失败的error_code的错误信息中我想添加modbus输出的错误信息就不太方便了。

版权声明

版权没有,违者不究! 转载注明出处,谢谢~!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容