Skip to main content

Module result

Module result 

Source
Expand description

API 统一响应格式 (Result Body)

定义 {code, msg, data} 三元组的统一响应体。 对齐 Java Result<T>,所有 API 端点均使用此格式返回。

§示例

use tdm_server_rust::common::{ResultBody, ErrorCode};

// 成功响应(无数据)
let res = ResultBody::<()>::success();
assert_eq!(res.code, 200);
assert_eq!(res.msg, "成功!");
assert!(res.data.is_none());

// 成功响应(带数据)
let res = ResultBody::success_data(vec![1, 2, 3]);
assert_eq!(res.code, 200);
assert_eq!(res.data, Some(vec![1, 2, 3]));

// 错误响应
let res = ResultBody::<()>::error("操作失败喵");
assert_eq!(res.code, 500);

// 指定错误码
let res = ResultBody::<()>::error_code(ErrorCode::LOGIN_REQUIRED, "请登录");
assert_eq!(res.code, 401);

Structs§

ResultBody
API 统一响应体

Functions§

download_failed
下载失败 500 纯文本响应。
download_forbidden
下载无权限 403 纯文本响应。
json_response
将任意可序列化类型转为 JSON HTTP 响应。
permission_denied_response
权限不足 403 JSON 响应。