Struct ql2::Response

pub struct Response {
    pub type: Option<i32>,
    pub error_type: Option<i32>,
    pub notes: Vec<i32>,
    pub token: Option<i64>,
    pub response: Vec<Datum>,
    pub backtrace: Option<Backtrace>,
    pub profile: Option<Datum>,
}

You get back a response with the same [token] as your query.

Fields

type: Option<i32>

error_type: Option<i32>

notes: Vec<i32>

token: Option<i64>

Indicates what Query this response corresponds to.

response: Vec<Datum>

response contains 1 RQL datum if [type] is [SUCCESS_ATOM] or [SERVER_INFO]. response contains many RQL data if [type] is [SUCCESS_SEQUENCE] or [SUCCESS_PARTIAL]. response contains 1 error message (of type [R_STR]) in all other cases.

backtrace: Option<Backtrace>

If [type] is [CLIENT_ERROR], [TYPE_ERROR], or [RUNTIME_ERROR], then a backtrace will be provided. The backtrace says where in the query the error occurred. Ideally this information will be presented to the user as a pretty-printed version of their query with the erroneous section underlined. A backtrace is a series of 0 or more Frames, each of which specifies either the index of a positional argument or the name of an optional argument. (Those words will make more sense if you look at the Term message below.)

Contains n Frames when you get back an error.

profile: Option<Datum>

If the [global_optargs] in the Query that this Response is a response to contains a key “profile” which maps to a static value of true then [profile] will contain a Datum which provides profiling information about the execution of the query. This field should be returned to the user along with the result that would normally be returned (a datum or a cursor). In official drivers this is accomplished by putting them inside of an object with “value” mapping to the return value and “profile” mapping to the profile object.

Implementations

impl Response

pub fn type(&self) -> ResponseType

Returns the enum value of type, or the default if the field is unset or set to an invalid enum value.

pub fn set_type(&mut self, value: ResponseType)

Sets type to the provided enum value.

pub fn token(&self) -> i64

Returns the value of token, or the default value if token is unset.

pub fn notes(
    &self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<ResponseNote>>

Returns an iterator which yields the valid enum values contained in notes.

pub fn push_notes(&mut self, value: ResponseNote)

Appends the provided enum value to notes.

pub fn error_type(&self) -> ErrorType

Returns the enum value of error_type, or the default if the field is unset or set to an invalid enum value.

pub fn set_error_type(&mut self, value: ErrorType)

Sets error_type to the provided enum value.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Self

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

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Response> for Response

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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