Struct Statement

pub struct Statement<'l> { /* private fields */ }

A prepared statement.

Implementations

impl<'l> Statement<'l>

pub fn bind<T: Bindable>(&mut self, value: T) -> Result<()>

Bind values to parameters.

In case of integer indices, the first parameter has index 1.

Examples

let query = "SELECT * FROM users WHERE name = ?";
let mut statement = connection.prepare(query)?;
statement.bind((1, "Bob"))?;

let query = "SELECT * FROM users WHERE name = ?";
let mut statement = connection.prepare(query)?;
statement.bind(&[(1, "Bob")][..])?;

let query = "SELECT * FROM users WHERE name = :name";
let mut statement = connection.prepare(query)?;
statement.bind((":name", "Bob"))?;

let query = "SELECT * FROM users WHERE name = :name";
let mut statement = connection.prepare(query)?;
statement.bind(&[(":name", "Bob")][..])?;

let query = "SELECT * FROM users WHERE id = :id AND name = :name";
let mut statement = connection.prepare(query)?;
statement.bind::<&[(_, Value)]>(&[
    (":id", 1.into()),
    (":name", "Bob".into()),
][..])?;

pub fn bind_iter<T, U>(&mut self, value: T) -> Result<()>

where T: IntoIterator<Item = U>, U: Bindable,

Bind values to parameters via an iterator.

Examples

let query = "INSERT INTO users VALUES (:id, :name)";
let mut statement = connection.prepare(query)?;
statement.bind_iter::<_, (_, Value)>([
    (":name", "Bob".into()),
    (":id", 42.into()),
])?;

pub fn iter(&mut self) -> Cursor<'l, '_>

Create a cursor.

pub fn next(&mut self) -> Result<State>

Advance to the next state.

The function should be called multiple times until State::Done is reached in order to evaluate the statement entirely.

pub fn read<T, U>(&self, index: U) -> Result<T>

where T: ReadableWithIndex, U: ColumnIndex,

Read a value from a column.

In case of integer indices, the first column has index 0.

pub fn column_count(&self) -> usize

Return the number of columns.

pub fn column_name<T: ColumnIndex>(&self, index: T) -> Result<&str>

Return the name of a column.

In case of integer indices, the first column has index 0.

pub fn column_names(&self) -> &[String]

Return column names.

pub fn column_type<T: ColumnIndex>(&self, index: T) -> Result<Type>

Return the type of a column.

The type becomes available after taking a step. In case of integer indices, the first column has index 0.

pub fn parameter_index(&self, parameter: &str) -> Result<Option<usize>>

Return the index for a named parameter if exists.

Examples

let query = "SELECT * FROM users WHERE name = :name";
let statement = connection.prepare(query)?;
assert_eq!(statement.parameter_index(":name")?.unwrap(), 1);
assert_eq!(statement.parameter_index(":asdf")?, None);

pub fn reset(&mut self) -> Result<()>

Reset the internal state.

Trait Implementations

impl<'l> Drop for Statement<'l>

fn drop(&mut self)

Executes the destructor for this type.

impl<'l, 'm> From<&'m mut Statement<'l>> for Cursor<'l, 'm>

fn from(statement: &'m mut Statement<'l>) -> Self

Converts to this type from the input type.

impl<'l> From<CursorWithOwnership<'l>> for Statement<'l>

fn from(cursor: CursorWithOwnership<'l>) -> Self

Converts to this type from the input type.

impl<'l> IntoIterator for Statement<'l>

type Item = Result<Row, Error>

The type of the elements being iterated over.

type IntoIter = CursorWithOwnership<'l>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.