Struct Response

#[non_exhaustive]
pub struct Response {
    pub data: Value,
    pub extensions: BTreeMap<String, Value>,
    pub cache_control: CacheControl,
    pub errors: Vec<ServerError>,
    pub http_headers: HeaderMap,
}

Query response

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data: Value

Data of query result

extensions: BTreeMap<String, Value>

Extensions result

cache_control: CacheControl

Cache control value

errors: Vec<ServerError>

Errors

http_headers: HeaderMap

HTTP headers

Implementations

impl Response

pub fn new(data: impl Into<Value>) -> Self

Create a new successful response with the data.

pub fn from_errors(errors: Vec<ServerError>) -> Self

Create a response from some errors.

pub fn extension(self, name: impl Into<String>, value: Value) -> Self

Set the extension result of the response.

pub fn http_headers(self, http_headers: HeaderMap) -> Self

Set the http headers of the response.

pub fn cache_control(self, cache_control: CacheControl) -> Self

Set the cache control of the response.

pub fn is_ok(&self) -> bool

Returns true if the response is ok.

pub fn is_err(&self) -> bool

Returns true if the response is error.

pub fn into_result(self) -> Result<Self, Vec<ServerError>>

Extract the error from the response. Only if the error field is empty will this return Ok.

Trait Implementations

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Response> for BatchResponse

fn from(response: Response) -> Self

Converts to this type from the input type.

impl PartialEq for Response

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Response

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Response