From 0572f80ed0d85f62fbc8cf799fa97aeb71a029ec Mon Sep 17 00:00:00 2001 From: Ivan Ukhov Date: Sat, 4 Jul 2015 09:21:38 -0400 Subject: [PATCH] Adjust the documentation --- src/connection.rs | 3 ++- src/statement.rs | 5 ++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/connection.rs b/src/connection.rs index 4a2e554..92b493d 100644 --- a/src/connection.rs +++ b/src/connection.rs @@ -41,7 +41,8 @@ impl<'l> Connection<'l> { /// Execute a query and process the resulting rows if any. /// /// The callback is triggered for each row. If the callback returns `false`, - /// no more rows will be processed. + /// no more rows will be processed. For large queries and non-string data + /// types, prepared statement are highly preferable; see `prepare`. #[inline] pub fn process(&self, sql: &str, callback: F) -> Result<()> where F: FnMut(&[(&str, Option<&str>)]) -> bool diff --git a/src/statement.rs b/src/statement.rs index 4a85023..88d55d5 100644 --- a/src/statement.rs +++ b/src/statement.rs @@ -52,7 +52,10 @@ impl<'l> Statement<'l> { Value::read(self, i) } - /// Evaluate the statement. + /// Evaluate the statement one step at a time. + /// + /// The function should be called multiple times until `State::Done` is + /// reached in order to evaluate the statement entirely. pub fn step(&mut self) -> Result { match unsafe { ffi::sqlite3_step(self.raw.0) } { ffi::SQLITE_DONE => Ok(State::Done),