API

`#errors`

import: #errors

counts: 6 函数, 4 方法, 3 类型, 0 常量, 1 方法集

错误值：StrErr / CodeErr / WrapErr 与 struct@ Error。动态装箱是语言语法 errors.Error(x)，不是本包函数。

`struct@ Error`

XuAPI

struct@ Error {
    fn msg() string
}

用途

方法集约束 `Error`。实现类型须提供下列方法。不是接口值。

参数

msg fn msg() string: `Error` 上的方法：返回错误或对象的文本。

`(Error) msg`

XuAPI

fn msg() string

用途

`Error` 上的方法：返回错误或对象的文本。

参数

self Self: 接收者 Self（值接收者）

string — 结果字符串

`struct StrErr`

XuAPI

pub struct StrErr {
    pub text string
}

用途

公开结构体 `StrErr`。

参数

text string: 文本

`(StrErr) msg`

XuAPI

pub fn (e StrErr) msg() string

用途

`StrErr` 上的方法：返回错误或对象的文本。

参数

e StrErr: 接收者 StrErr（值接收者）

string — 结果字符串

`struct CodeErr`

XuAPI

pub struct CodeErr {
    pub code int
    pub text string
}

用途

公开结构体 `CodeErr`。

参数

code int: 码
text string: 文本

`(CodeErr) msg`

XuAPI

pub fn (e CodeErr) msg() string

用途

`CodeErr` 上的方法：返回错误或对象的文本。

参数

e CodeErr: 接收者 CodeErr（值接收者）

string — 结果字符串

`code`

XuAPI

pub fn code(code int, text string) CodeErr

用途

码。

参数

code int: 码（int）
text string: 文本（string）

CodeErr — 该类型的值

`new`

XuAPI

pub fn new(text string) StrErr

用途

构造该类型的新值。

参数

text string: 文本（string）

StrErr — 该类型的值

`struct WrapErr`

XuAPI

pub struct WrapErr {
    pub text string
    pub cause string
}

用途

公开结构体 `WrapErr`。

参数

text string: 文本
cause string: 字段（string）

`(WrapErr) msg`

XuAPI

pub fn (w WrapErr) msg() string

用途

`WrapErr` 上的方法：返回错误或对象的文本。

参数

w WrapErr: 接收者 WrapErr（值接收者）

string — 结果字符串

`wrap`

XuAPI

pub fn wrap(text string, err Error) WrapErr

用途

包装。

参数

text string: 文本（string）
err Error: 错误（Error）

WrapErr — 该类型的值

`(WrapErr) cause`

XuAPI

pub fn (w WrapErr) cause() string

用途

`WrapErr` 上的方法：返回被包装的底层错误文本。

参数

w WrapErr: 接收者 WrapErr（值接收者）

string — 结果字符串

`is_err`

XuAPI

pub fn is_err(err Error, target Error) bool

用途

判断是否 err。

参数

err Error: 错误（Error）
target Error: target（Error）

bool — 是否成立

`join`

XuAPI

pub fn join(a Error, b Error) StrErr

用途

用分隔符拼接各段。

参数

a Error: 值（Error）
b Error: b（Error）

StrErr — 该类型的值

`unwrap`

XuAPI

pub fn unwrap(err Error) string

用途

unwrap，返回 string。

参数

err Error: 错误（Error）

string — 结果字符串