Struct scylla::transport::query_result::QueryResult

pub struct QueryResult { /* private fields */ }

Result of a single request to the database. It represents any kind of Result frame.

The received rows and metadata, which are present if the frame is of Result:Rows kind, are kept in a raw binary form. To deserialize and access them, transform QueryResult to QueryRowsResult by calling QueryResult::into_rows_result.

NOTE: this is a result of a single CQL request. If you use paging for your query, this will contain exactly one page.

Implementations

impl QueryResult

pub fn warnings(&self) -> impl Iterator<Item = &str>

Warnings emitted by the database.

pub fn tracing_id(&self) -> Option<Uuid>

Tracing ID associated with this CQL request.

pub fn is_rows(&self) -> bool

Returns a bool indicating the current response is of Rows type.

pub fn result_not_rows(&self) -> Result<(), ResultNotRowsError>

Returns Ok for a request’s result that shouldn’t contain any rows.
Will return Ok for INSERT result, but a SELECT result, even an empty one, will cause an error.
Opposite of QueryResult::into_rows_result.

pub fn into_rows_result(self) -> Result<QueryRowsResult, IntoRowsResultError>

Transforms itself into the Rows result type to enable deserializing rows. Deserializes result metadata and allocates it.

Returns an error if the response is not of Rows kind or metadata deserialization failed.

let rows_result = query_result.into_rows_result()?;

let mut rows_iter = rows_result.rows::<(i32, &str)>()?;
while let Some((num, text)) = rows_iter.next().transpose()? {
    // do something with `num` and `text``
}

Ok(())

If the response is not of Rows kind, the original QueryResult (self) is returned back to the user in the error type. See IntoRowsResultError documentation.

let err = non_rows_query_result.into_rows_result().unwrap_err();

match err {
    IntoRowsResultError::ResultNotRows(query_result) => {
        // do something with original `query_result`
    }
    _ => {
        // deserialization failed - query result is not recovered
    }
}

Ok(())

pub fn into_legacy_result( self, ) -> Result<LegacyQueryResult, IntoLegacyQueryResultError>

👎Deprecated since 0.15.0: Legacy deserialization API is inefficient and is going to be removed soon

Transforms itself into the legacy result type, by eagerly deserializing rows into the Row type. This is inefficient, and should only be used during transition period to the new API.

Trait Implementations

impl Clone for QueryResult

fn clone(&self) -> QueryResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryResult

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

Formats the value using the given formatter.