Extra Flags

extra flags 是一组额外的标志

FlagWrap

flag wrap 提供了一个发送额外标志的包装器

当使用额外标志时，您需要将返回类型从 RespResult<T, E> 更改为 RespResult<FlagWrap<T>, E>

以下示例将状态码更改为 404 Not Found

use resp_result::{RespError, RespResult, FlagWrap, ExtraFlag};
use std::borrow::Cow;
use http::StatusCode;

pub struct PlainError(String);

impl RespError for PlainError{
    fn log_message(&self) -> Cow<'_, str> {
        Cow::Owned(format!("PlainError: {}", self.0))
    }

    type ExtraMessage = String;

    fn extra_message(&self) -> Self::ExtraMessage {
            self.0.clone()
    }
}
/// this can be used as the handler return type
type PlainRResult<T> = RespResult<T, PlainError>;

pub async fn welcome_short_name(
    name: String,
    ) -> PlainRResult<FlagWrap<String>>{
        if name.len() >= 8{
            RespResult::ok(
                format!("welcome! {name} your name size is {}",name.len()))
                // using `with_flags` to covert RespResult<T, E>
                // to `RespResult<FlagWrap<T>, E>`
                // using `()` for no extra flags
                .with_flags(())
        }else{
            // using `flag_ok` directly construct a flag with the resp result
            RespResult::flag_ok(
                format!("Welcome! {name}"),
                ExtraFlag::status(StatusCode::NOT_FOUND)
            )
        }
    }

影响 RespResult 的行为

默认情况下，RespResult 将按如下方式序列化响应体

{
  "is-ok": true,
  "error-message": "...",
  "extra-msg": "...",
  "body": null
}

可以使用 set_config 使用 set_config 来设置全局配置以更改默认行为

例如，通过配置，我们可以将响应体更改为以下内容

{
  "status": "fail",
  "reterror": 10001,
  "message": "something wrong",
  "body": null
}

有关更多信息，请参阅 ConfigTrait 的文档

帮助宏

resp_result 属性宏

此宏用于函数。它将原始 Result<T,E> 转换为 RespResult，这使得编写处理程序更加方便。

注意：在 Result 实现中需要 E，实现 RespError

• 示例

// the `rresult` is an alias of `resp_result`
// the function `test` now will return a `RespResult`
#[rresult]
fn test((a, b): (i32, i64), foo: String) -> Result<(), PlainError> {
    println!("{a},{b},{foo}");
    let a = foo.parse::<i32>()?;
    println!("{a:?}");
    Ok(())
}

RespError 派生宏

在为枚举实现 RespError 时使用此宏，通常与 thiserror 一起使用

现在枚举的每个变体都有两个参数

1. err_msg：返回给客户端的消息，通常需要与 log_message 相比删除敏感信息。如果没有提供，将使用 log_message
2. err_code：此类错误返回的 HTTP 状态码。如果没有提供，将默认为 500

以下是一个示例

    use std::num::ParseIntError;

    use axum::extract::rejection::PathRejection;
    use axum_resp_result::RespError;
    #[derive(Debug, thiserror::Error, RespError)]
    pub(super) enum PlainError {
        #[error("Parse Request Path Error: {0}")]
        #[resp_result(
            err_msg = "Parse Request Path Error", 
            // the error_code can either the code number or the code name
            err_code = 400
        )]
        Path(#[from] PathRejection),
        #[error("Parse Int Error: {0}")]
        #[resp_result(err_msg = "Invalid Input Integer", err_code = "Bad Request")]
        ParseInt(#[from] ParseIntError),
    }