Skip to main content

ResultBody

Struct ResultBody 

Source
pub struct ResultBody<T> {
    pub code: i32,
    pub msg: String,
    pub data: Option<T>,
}
Expand description

API 统一响应体

所有 HTTP API 的响应均包装为此格式:

{
  "code": 200,
  "msg": "成功!",
  "data": { ... }
}

§构造方法

方法code用途
success()200无数据成功响应
success_data()200带数据成功响应
error()500通用失败响应
error_code()自定义指定错误码的失败响应

§Panics

本结构体及其方法均不 panic。序列化失败时通过 [IntoResponse] 优雅降级为 500 JSON 错误响应。

§辅助函数

Fields§

§code: i32

响应码,200 成功

§msg: String

响应消息

§data: Option<T>

业务数据

Implementations§

Source§

impl<T: Serialize> ResultBody<T>

Source

pub fn success() -> Self

构建无数据的成功响应。

§返回值

返回 code=200, msg="成功!", data=NoneResultBody

§示例
use tdm_server_rust::common::ResultBody;
let res: ResultBody<()> = ResultBody::success();
assert_eq!(res.code, 200);
Source

pub fn success_data(data: T) -> Self

构建带数据的成功响应。

§返回值

返回 code=200, msg="成功!", data=Some(data)ResultBody

§示例
use tdm_server_rust::common::ResultBody;
let res = ResultBody::success_data(42);
assert_eq!(res.data, Some(42));
Source

pub fn error(msg: impl Into<String>) -> ResultBody<()>

构建通用失败响应(错误码 500)。

§返回值

返回 code=500, msg=<传入消息>, data=NoneResultBody<()>

Source

pub fn error_code(code: i32, msg: impl Into<String>) -> ResultBody<()>

构建指定错误码的失败响应。

§参数
  • code: 业务错误码,参见 ErrorCode 常量
  • msg: 错误描述消息
§返回值

返回 code=<指定值>, msg=<传入消息>, data=NoneResultBody<()>

Trait Implementations§

Source§

impl<T: Clone> Clone for ResultBody<T>

Source§

fn clone(&self) -> ResultBody<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for ResultBody<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: Serialize> IntoResponse for ResultBody<T>

ResultBody 转为 axum HTTP 响应。

Content-Type 对齐 Java: application/json;charset=UTF-8

§Errors

JSON 序列化失败时返回 500 {"code":500,"msg":"JSON 序列化失败: ...","data":null} 纯文本降级。 此错误不应在正常业务中出现,仅当 TSerialize 实现有 bug 才会触发。

Source§

fn into_response(self) -> Response

Create a response.
Source§

impl<T> Serialize for ResultBody<T>
where T: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ResultBody<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ResultBody<T>
where T: RefUnwindSafe,

§

impl<T> Send for ResultBody<T>
where T: Send,

§

impl<T> Sync for ResultBody<T>
where T: Sync,

§

impl<T> Unpin for ResultBody<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for ResultBody<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for ResultBody<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T, S> Handler<IntoResponseHandler, S> for T
where T: IntoResponse + Clone + Send + 'static,

§

type Future = Ready<Response<Body>>

The type of future calling this handler returns.
§

fn call( self, _req: Request<Body>, _state: S, ) -> <T as Handler<IntoResponseHandler, S>>::Future

Call the handler with the given request.
§

fn layer<L>(self, layer: L) -> Layered<L, Self, T, S>
where L: Layer<HandlerService<Self, T, S>> + Clone, <L as Layer<HandlerService<Self, T, S>>>::Service: Service<Request<Body>>,

Apply a [tower::Layer] to the handler. Read more
§

fn with_state(self, state: S) -> HandlerService<Self, T, S>

Convert the handler into a [Service] by providing the state
§

impl<H, T> HandlerWithoutStateExt<T> for H
where H: Handler<T, ()>,

§

fn into_service(self) -> HandlerService<H, T, ()>

Convert the handler into a [Service] and no state.
§

fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, ()>>

Convert the handler into a MakeService and no state. Read more
§

fn into_make_service_with_connect_info<C>( self, ) -> IntoMakeServiceWithConnectInfo<HandlerService<H, T, ()>, C>

Convert the handler into a MakeService which stores information about the incoming connection and has no state. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more