ISAR/rusqlite
3
0
Fork 0
mirror of https://github.com/isar/rusqlite.git synced 2024-10-23 15:01:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add Failure documentation

Browse Source
This commit is contained in:
Gwenael Treguier 2015-12-05 11:28:33 +01:00
parent cef1d3285e
commit 2cf0455f8d
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/blob.rs
View File

@ -21,6 +21,11 @@ pub enum SeekFrom {
impl SqliteConnection { impl SqliteConnection {
/// Open a handle to the BLOB located in `row`, `column`, `table` in database `db` ('main', 'temp', ...) /// Open a handle to the BLOB located in `row`, `column`, `table` in database `db` ('main', 'temp', ...)
///
/// # Failure
///
/// Will return `Err` if `db`/`table`/`column` cannot be converted to a C-compatible string or if the
/// underlying SQLite BLOB open call fails.
pub fn blob_open<'a>(&'a self, db: &str, table: &str, column: &str, row: i64, read_only: bool) -> SqliteResult<SqliteBlob<'a>> { pub fn blob_open<'a>(&'a self, db: &str, table: &str, column: &str, row: i64, read_only: bool) -> SqliteResult<SqliteBlob<'a>> {
let mut c = self.db.borrow_mut(); let mut c = self.db.borrow_mut();
let mut blob = ptr::null_mut(); let mut blob = ptr::null_mut();
@ -36,6 +41,10 @@ impl SqliteConnection {
impl<'conn> SqliteBlob<'conn> { impl<'conn> SqliteBlob<'conn> {
/// Move a BLOB handle to a new row /// Move a BLOB handle to a new row
///
/// # Failure
///
/// Will return `Err` if the underlying SQLite BLOB reopen call fails.
pub fn reopen(&mut self, row: i64) -> SqliteResult<()> { pub fn reopen(&mut self, row: i64) -> SqliteResult<()> {
let rc = unsafe{ ffi::sqlite3_blob_reopen(self.blob, row) }; let rc = unsafe{ ffi::sqlite3_blob_reopen(self.blob, row) };
if rc != ffi::SQLITE_OK { if rc != ffi::SQLITE_OK {
@ -51,6 +60,10 @@ impl<'conn> SqliteBlob<'conn> {
} }
/// Read data from a BLOB incrementally /// Read data from a BLOB incrementally
///
/// # Failure
///
/// Will return `Err` if `buf` length > i32 max value or if the underlying SQLite read call fails.
pub fn read(&mut self, buf: &mut [u8]) -> SqliteResult<i32> { pub fn read(&mut self, buf: &mut [u8]) -> SqliteResult<i32> {
if buf.len() > ::std::i32::MAX as usize { if buf.len() > ::std::i32::MAX as usize {
return Err(SqliteError { return Err(SqliteError {
@ -76,6 +89,11 @@ impl<'conn> SqliteBlob<'conn> {
/// Write data into a BLOB incrementally /// Write data into a BLOB incrementally
/// ///
/// This function may only modify the contents of the BLOB; it is not possible to increase the size of a BLOB using this API. /// This function may only modify the contents of the BLOB; it is not possible to increase the size of a BLOB using this API.
///
/// # Failure
///
/// Will return `Err` if `buf` length > i32 max value or if `buf` length + offset > BLOB size
/// or if the underlying SQLite write call fails.
pub fn write(&mut self, buf: &[u8]) -> SqliteResult<i32> { pub fn write(&mut self, buf: &[u8]) -> SqliteResult<i32> {
if buf.len() > ::std::i32::MAX as usize { if buf.len() > ::std::i32::MAX as usize {
return Err(SqliteError { return Err(SqliteError {
@ -108,6 +126,10 @@ impl<'conn> SqliteBlob<'conn> {
} }
/// Close a BLOB handle /// Close a BLOB handle
///
/// # Failure
///
/// Will return `Err` if the underlying SQLite close call fails.
pub fn close(mut self) -> SqliteResult<()> { pub fn close(mut self) -> SqliteResult<()> {
self.close_() self.close_()
} }