Struct rusqlite::functions::Context

pub struct Context<'a> { /* private fields */ }

Context is a wrapper for the SQLite function evaluation context.

Implementations

impl<'a> Context<'a>

pub fn len(&self) -> usize

Returns the number of arguments to the function.

pub fn is_empty(&self) -> bool

Returns true when there is no argument.

pub fn get<T: FromSql>(&self, idx: usize) -> Result<T>

Returns the idxth argument as a T.

Failure

Will panic if idx is greater than or equal to self.len().

Will return Err if the underlying SQLite type cannot be converted to a T.

pub fn get_raw(&self, idx: usize) -> ValueRef<'a>

Returns the idxth argument as a ValueRef.

Failure

Will panic if idx is greater than or equal to self.len().

pub fn set_aux<T>(&self, arg: c_int, value: T)

Sets the auxilliary data associated with a particular parameter. See https://www.sqlite.org/c3ref/get_auxdata.html for a discussion of this feature, or the unit tests of this module for an example.

pub unsafe fn get_aux<T>(&self, arg: c_int) -> Option<&T>

Gets the auxilliary data that was associated with a given parameter via set_aux. Returns None if no data has been associated.

Unsafety

This function is unsafe as there is no guarantee that the type T requested matches the type T that was provided to set_aux. The types must be identical.