Skip to main content

Response

Struct Response 

Source
#[non_exhaustive]
pub struct Response { pub request_id: String, pub status: String, pub kind: String, pub data: Value, pub route: Option<String>, pub elapsed_ms: Option<i64>, pub warnings: Vec<String>, pub error_code: Option<String>, pub leader_hint: Option<String>, }
Expand description

A decoded RESPONSE frame.

Response::data is the payload of whichever variant the operation produced, and Response::kind names that variant — "Json", "CacheValue", "Rows", "Documents", "Message", "Toon" or "Empty". The typed methods on crate::Client decode this for you; it is public so an operation this crate has no method for is still reachable through crate::Client::request.

Fields (Non-exhaustive)§

This struct is marked as 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.
§request_id: String

The request_id the server echoed back.

§status: String

The server’s status. "ok" on success; any other value is reported as an error rather than returned.

§kind: String

The name of the data variant, or an empty string when there was no data.

§data: Value

That variant’s payload, still as JSON.

§route: Option<String>

Which route served the request.

§elapsed_ms: Option<i64>

How long the server took.

§warnings: Vec<String>

Non-fatal warnings. Not decorative: a broadcast DDL that could not reach every shard reports it here while the status is still "ok".

§error_code: Option<String>

The server’s machine-readable failure code, when it failed.

§leader_hint: Option<String>

On a not_leader refusal, the leader’s host:port when the cluster knows one.

Implementations§

Source§

impl Response

Source

pub fn json<T: DeserializeOwned>(&self) -> Result<T>

Decode the payload into a type of your own.

Trait Implementations§

Source§

impl Clone for Response

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 Response

Source§

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

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

impl PartialEq for Response

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 StructuralPartialEq for Response

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.