Skip to main content

AppResponse

Struct AppResponse 

Source
pub struct AppResponse {
    pub code: i32,
    pub data: Value,
    pub message: String,
    pub meta: Meta,
}
Expand description

Standardized app-level response placed in JSON-RPC result.

Implements AppResponseView / AppResponseMut so application crates can wrap or override helpers Public fields are for serde and call-site convenience.

§Examples

use simplejrpc::AppResponse;
use serde_json::json;
let r = AppResponse::ok(json!(1));
assert_eq!(r.code, 200);
assert_eq!(r.data, json!(1));

Fields§

§code: i32

HTTP-style status code (200 success, 400/404/… for app errors).

§data: Value

Business payload (null on error envelopes).

§message: String

Human message (msg in JSON).

§meta: Meta

Optional metadata (endpoint name, close hint).

Implementations§

Source§

impl AppResponse

Source

pub fn ok(data: Value) -> Self

Build a success envelope (code = 200, msg = "OK").

§Examples
use simplejrpc::AppResponse;
use serde_json::json;
let r = AppResponse::ok(json!("pong"));
assert_eq!(r.code, 200);
assert_eq!(r.data, json!("pong"));
Source

pub fn error(code: i32, message: impl Into<String>) -> Self

Build an error envelope (data is always JSON null).

§Examples
use simplejrpc::AppResponse;
let r = AppResponse::error(404, "Not Found");
assert_eq!(r.code, 404);
assert!(r.data.is_null());
Source

pub fn from_parts(code: i32, data: Value, message: String, meta: Meta) -> Self

Build from raw parts.

§Examples
use simplejrpc::response::{AppResponse, Meta};
use serde_json::json;
let r = AppResponse::from_parts(200, json!(1), "OK".into(), Meta::default());
assert!(r.is_ok());
Source

pub fn into_parts(self) -> (i32, Value, String, Meta)

Split into raw parts (pair with Self::from_parts).

§Examples
use simplejrpc::AppResponse;
use serde_json::json;
let (code, data, msg, meta) = AppResponse::ok(json!(1)).into_parts();
assert_eq!(code, 200);
assert_eq!(data, json!(1));
assert_eq!(msg, "OK");
assert_eq!(meta.close, 0);
Source

pub fn is_ok(&self) -> bool

Whether Self::code is 200.

§Examples
use simplejrpc::AppResponse;
use serde_json::json;
assert!(AppResponse::ok(json!(null)).is_ok());
assert!(!AppResponse::error(400, "x").is_ok());
Source

pub fn with_endpoint(self, endpoint: impl Into<String>) -> Self

Set Meta::endpoint (fluent).

§Examples
use simplejrpc::AppResponse;
use serde_json::json;
let r = AppResponse::ok(json!(null)).with_endpoint("add");
assert_eq!(r.meta.endpoint, "add");
Source

pub fn with_close(self, close: i32) -> Self

Set Meta::close (fluent).

§Examples
use simplejrpc::AppResponse;
use serde_json::json;
let r = AppResponse::ok(json!(null)).with_close(1);
assert_eq!(r.meta.close, 1);
Source

pub fn with_data(self, data: Value) -> Self

Replace Self::data (fluent).

§Examples
use simplejrpc::AppResponse;
use serde_json::json;
let r = AppResponse::ok(json!(null)).with_data(json!([1, 2]));
assert_eq!(r.data, json!([1, 2]));
Source

pub fn with_message(self, message: impl Into<String>) -> Self

Replace Self::message (fluent).

§Examples
use simplejrpc::AppResponse;
use serde_json::json;
let r = AppResponse::ok(json!(null)).with_message("done");
assert_eq!(r.message, "done");

Trait Implementations§

Source§

impl AppResponseMut for AppResponse

Source§

fn set_code(&mut self, code: i32)

Replace the envelope status code.
Source§

fn set_data(&mut self, data: Value)

Replace the business payload.
Source§

fn set_message(&mut self, message: impl Into<String>)

Replace the human message (msg).
Source§

fn set_meta(&mut self, meta: Meta)

Replace the entire Meta block.
Source§

fn meta_mut(&mut self) -> &mut Meta

Mutable access to metadata (endpoint / close).
Source§

fn with_endpoint(self, endpoint: impl Into<String>) -> Self
where Self: Sized,

Set Meta::endpoint (fluent, consumes self).
Source§

fn with_close(self, close: i32) -> Self
where Self: Sized,

Set Meta::close (fluent, consumes self).
Source§

fn with_data(self, data: Value) -> Self
where Self: Sized,

Replace data (fluent, consumes self).
Source§

fn with_message(self, message: impl Into<String>) -> Self
where Self: Sized,

Replace message (fluent, consumes self).
Source§

impl AppResponseView for AppResponse

Source§

fn code(&self) -> i32

Status code (200, 404, or a 200xxx business code).
Source§

fn data(&self) -> &Value

Payload (data).
Source§

fn message(&self) -> &str

Message (msg).
Source§

fn meta(&self) -> &Meta

Meta block.
Source§

fn is_ok(&self) -> bool

code == 200.
Source§

fn to_app_response(&self) -> AppResponse

Build an AppResponse from the view getters.
Source§

impl Clone for AppResponse

Source§

fn clone(&self) -> Self

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 Debug for AppResponse

Source§

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

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

impl Default for AppResponse

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AppResponse

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AppResponse

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for AppResponse

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
Source§

impl StructuralPartialEq for AppResponse

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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