Documentation
¶
Overview ¶
Package errcode 是 fleetly 错误码注册表(代码内唯一真源)。
契约纪律(架构 §2.8「契约版本化纪律」):错误码为稳定字符串 (`E_<域>_<条件>` / `W_<域>_<条件>`),永不复用、只新增;文档域清单 (release-semantics §2.7、stateful-placement §2.8/§2.9、state-model §2.7/§2.9、architecture §2.3/§2.4)为定义性说明,注册表为运行时真源。 每码携带默认 HTTP 状态映射、默认 suggestion 文案与 docs 锚点。
fail-fast:重复注册、非法格式、E_/W_ 与 HTTP 映射不一致均在构造期 (Default 注册表构建 = 包初始化)panic,保证「只增、不复用」在进程 启动即被校验。
Index ¶
Constants ¶
View Source
const DocsURLPrefix = "https://docs.fleetly.dev/errors/"
DocsURLPrefix 是错误码文档锚点 URL 前缀(占位:文档站域名与路径结构 待 T0.5 契约冻结定稿;锚点 = 前缀 + 码 ID)。
Variables ¶
This section is empty.
Functions ¶
func HTTPStatus ¶
HTTPStatus 返回码的默认 HTTP 状态;未注册码返回 0(调用方须自行兜底, 注册表不发明文档外码)。
Types ¶
type Code ¶
type Code struct {
// ID 稳定码字符串,如 "E_COMPOSE_UNSUPPORTED"。
ID string
// HTTP 是该码的默认 HTTP 状态映射;W_ 警告码恒为 0(警告是资源上的
// 标注/事件,不作为 HTTP 错误出现,发布专项 §2.7「部署失败是资源终态
// 而非 HTTP 错误」同理适用)。
HTTP int
// Summary 一句话语义(注册表内说明,不进信封)。
Summary string
// Suggestion 默认修复建议(ErrorResponse.suggestion 的默认占位文案,
// 业务侧可覆盖;措辞冻结前可调整)。
Suggestion string
}
Code 是一个已注册错误码。
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry 是错误码注册表(只增:注册成功后不可删除或改写)。
func (*Registry) MustRegister ¶
MustRegister 注册一个码:格式非法、重复注册、HTTP 映射与码类不一致时 panic(构造期 fail-fast)。
Click to show internal directories.
Click to hide internal directories.