Struct QueryRequest 

pub struct QueryRequest { /* private fields */ }

Full query request.

The request kind is derived from the closed BatchQuery variant. The serializer retains the redundant legacy request_type wire field, while deserialization rejects disagreement between the two tags.

Implementations

impl QueryRequest

pub fn read(query: ReadBatch) -> QueryRequest

Create a read request.

pub fn write(query: WriteBatch) -> QueryRequest

Create a write request.

pub const fn request_type(&self) -> QueryRequestType

Derived request kind.

pub const fn query(&self) -> &BatchQuery

Closed query payload.

pub fn query_name(&self) -> Option<&str>

Optional query name.

pub fn parameters(&self) -> Option<&BTreeMap<String, QueryValue>>

Runtime parameter values.

pub fn parameter_types(&self) -> Option<&BTreeMap<String, QueryParamType>>

Declared parameter schema, when the request uses typed parameters.

pub fn into_query(self) -> (BatchQuery, BTreeMap<String, QueryValue>)

Consume the validated request into its closed query and runtime values.

pub fn try_insert_untyped_parameter( &mut self, name: impl Into<String>, value: QueryValue, ) -> Result<(), QueryError>

Insert an explicitly untyped parameter.

pub fn insert_parameter_value( &mut self, name: impl Into<String>, value: QueryValue, )

Insert an explicitly untyped parameter.

This compatibility builder cannot create an invalid request: invalid names, values, or typed/untyped mixing panic at the call site.

pub fn try_insert_typed_parameter( &mut self, name: impl Into<String>, ty: QueryParamType, value: QueryValue, ) -> Result<(), QueryError>

Atomically insert a typed parameter.

pub fn set_query_name(&mut self, name: impl Into<String>)

Set query name.

pub fn clear_query_name(&mut self)

Clear query name.

pub fn with_parameter_value( self, name: impl Into<String>, value: QueryValue, ) -> QueryRequest

Add parameter value.

pub fn with_typed_parameter( self, name: impl Into<String>, ty: QueryParamType, value: QueryValue, ) -> Result<QueryRequest, QueryError>

Add an atomic typed parameter.

pub fn with_query_name(self, name: impl Into<String>) -> QueryRequest

Set query name.

pub fn to_json_bytes(&self) -> Result<Vec<u8>, QueryError>

Serialize to JSON bytes.

pub fn to_json_string(&self) -> Result<String, QueryError>

Serialize to JSON string.

Trait Implementations

impl Clone for QueryRequest

fn clone(&self) -> QueryRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryRequest

fn deserialize<D>( deserializer: D, ) -> Result<QueryRequest, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for QueryRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QueryRequest

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.

impl StructuralPartialEq for QueryRequest