Struct msql_srv::QueryResultWriter

#[must_use]
pub struct QueryResultWriter<'a, W: Write> { /* fields omitted */ }

Convenience type for providing query results to clients.

This type should not be dropped without calling start, completed, or error.

To send multiple resultsets, use RowWriter::finish_one and complete_one. These are similar to RowWriter::finish and completed, but both eventually yield back the QueryResultWriter so that another resultset can be sent. To indicate that no more resultset will be sent, call no_more_results. All methods on QueryResultWriter (except no_more_results) automatically start a new resultset. The QueryResultWriter may be dropped without calling no_more_results, but in this case the program may panic if an I/O error occurs when sending the end-of-records marker to the client. To handle such errors, call no_more_results explicitly.

Implementations

impl<'a, W: Write> QueryResultWriter<'a, W>

pub fn start(self, columns: &'a [Column]) -> Result<RowWriter<'a, W>>

Start a resultset response to the client that conforms to the given columns.

Note that if no columns are emitted, any written rows are ignored.

See RowWriter.

pub fn complete_one(self, rows: u64, last_insert_id: u64) -> Result<Self>

Send an empty resultset response to the client indicating that rows rows were affected by the query in this resultset. last_insert_id may be given to communiate an identifier for a client’s most recent insertion.

pub fn completed(self, rows: u64, last_insert_id: u64) -> Result<()>

Send an empty resultset response to the client indicating that rows rows were affected by the query. last_insert_id may be given to communiate an identifier for a client’s most recent insertion.

pub fn error<E: ?Sized>(self, kind: ErrorKind, msg: &E) -> Result<()> where
    E: Borrow<[u8]>, 

Reply to the client’s query with an error.

pub fn no_more_results(self) -> Result<()>

Send the last bits of the last resultset to the client, and indicate that there are no more resultsets coming.

Trait Implementations

impl<'a, W: Write> Drop for QueryResultWriter<'a, W>

fn drop(&mut self)

Executes the destructor for this type.