Struct Res

Source

pub struct Res<T = ()>where
    T: Serialize,{
    pub code: i32,
    pub msg: String,
    pub data: Option<T>,
}

Expand description

统一 API 响应结构

Fields§

§code: i32

业务码，0 表示成功

§msg: String

提示信息

§data: Option<T>

数据载荷

Implementations§

Source §

impl Res

Source

pub fn ok_empty() -> Res

成功（无数据载荷），返回 {code: 0, msg: "ok", data: null}

Source

pub fn ok_msg(msg: impl Into<String>) -> Res

成功（自定义消息，无数据载荷）

Source §

impl<T> Res<T>
where T: Serialize,

Source

pub fn ok(data: T) -> Res<T>

成功响应，携带数据载荷

§示例

Res::ok(user)          // => {code: 0, msg: "ok", data: user}
Res::ok("hello")       // => {code: 0, msg: "ok", data: "hello"}

Source

pub fn ok_with_msg(data: T, msg: impl Into<String>) -> Res<T>

成功响应，携带数据载荷和自定义消息

Source

pub fn fail(code: i32, msg: impl Into<String>) -> Res<T>

失败响应（自定义错误码和消息，无数据载荷）

§示例

Res::fail(codes::BAD_REQUEST, "用户名不能为空")

Source §

impl<T> Res<PageData<T>>
where T: Serialize,

Source

pub fn page(list: T, total: u64, page: u64, page_size: u64) -> Res<PageData<T>>

分页响应

Trait Implementations§

Source §

impl<T> Clone for Res<T>
where T: Clone + Serialize,

Source §

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

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<T> Debug for Res<T>
where T: Debug + Serialize,

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<T> IntoResponse for Res<T>
where T: Serialize,

Available on crate feature axum only.

Source §

fn into_response(self) -> Response<Body>

Create a response.

Source §

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

Source §

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> UnwindSafe for Res<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.

Source §

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

Source §

fn from_ref(input: &T) -> T

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

Source §

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

Source §

type Future = Ready<Response<Body>>

The type of future calling this handler returns.

Source §

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

Call the handler with the given request.

Source §

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

Source §

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

Convert the handler into a Service by providing the state

Source §

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

Source §

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

Convert the handler into a Service and no state.

Source §

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

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

Source §

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

Source §

impl<T> Instrument for T

Source §

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

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

Source §

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 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> 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 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

fn vzip(self) -> V

Source §

impl<T> WithSubscriber for T

Source §

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

Source §

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Source §

Struct Res Copy item path

Fields§

Implementations§

impl Res

pub fn ok_empty() -> Res

pub fn ok_msg(msg: impl Into<String>) -> Res

impl<T> Res<T>where T: Serialize,

pub fn ok(data: T) -> Res<T>

§示例

pub fn ok_with_msg(data: T, msg: impl Into<String>) -> Res<T>

pub fn fail(code: i32, msg: impl Into<String>) -> Res<T>

§示例

impl<T> Res<PageData<T>>where T: Serialize,

pub fn page(list: T, total: u64, page: u64, page_size: u64) -> Res<PageData<T>>

Trait Implementations§

impl<T> Clone for Res<T>where T: Clone + Serialize,

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

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

impl<T> Debug for Res<T>where T: Debug + Serialize,

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

impl<T> IntoResponse for Res<T>where T: Serialize,

fn into_response(self) -> Response<Body>

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

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

Auto Trait Implementations§

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

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

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

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

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

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

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn from_ref(input: &T) -> T

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

type Future = Ready<Response<Body>>

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

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>>,

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

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

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

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

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

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for Twhere 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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<A, B, T> HttpServerConnExec<A, B> for Twhere B: Body,

Struct Res

impl<T> Res<T>
where T: Serialize,

impl<T> Res<PageData<T>>
where T: Serialize,

impl<T> Clone for Res<T>
where T: Clone + Serialize,

impl<T> Debug for Res<T>
where T: Debug + Serialize,

impl<T> IntoResponse for Res<T>
where T: Serialize,

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

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

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

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

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

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

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

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

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

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

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

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

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

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

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>>,

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

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

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

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

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

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

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,