Merge pull request #1609 from gwenn/limit

Check limit
This commit is contained in:
gwenn 2024-12-07 13:21:24 +01:00 committed by GitHub
commit 8081589201
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,6 +1,6 @@
//! Run-Time Limits //! Run-Time Limits
use crate::{ffi, Connection}; use crate::{ffi, Connection, Error, Result};
use std::os::raw::c_int; use std::os::raw::c_int;
/// Run-Time limit categories, for use with [`Connection::limit`] and /// Run-Time limit categories, for use with [`Connection::limit`] and
@ -44,24 +44,47 @@ pub enum Limit {
/// The maximum number of auxiliary worker threads that a single prepared /// The maximum number of auxiliary worker threads that a single prepared
/// statement may start. /// statement may start.
SQLITE_LIMIT_WORKER_THREADS = ffi::SQLITE_LIMIT_WORKER_THREADS, SQLITE_LIMIT_WORKER_THREADS = ffi::SQLITE_LIMIT_WORKER_THREADS,
/// Only used for testing
#[cfg(test)]
INVALID = -1,
} }
impl Connection { impl Connection {
/// Returns the current value of a [`Limit`]. /// Returns the current value of a [`Limit`].
#[inline] #[inline]
#[cfg_attr(docsrs, doc(cfg(feature = "limits")))] #[cfg_attr(docsrs, doc(cfg(feature = "limits")))]
pub fn limit(&self, limit: Limit) -> i32 { pub fn limit(&self, limit: Limit) -> Result<i32> {
let c = self.db.borrow(); let c = self.db.borrow();
unsafe { ffi::sqlite3_limit(c.db(), limit as c_int, -1) } let rc = unsafe { ffi::sqlite3_limit(c.db(), limit as c_int, -1) };
if rc < 0 {
return Err(Error::SqliteFailure(
ffi::Error::new(ffi::SQLITE_RANGE),
Some(format!("{limit:?} is invalid")),
));
}
Ok(rc)
} }
/// Changes the [`Limit`] to `new_val`, returning the prior /// Changes the [`Limit`] to `new_val`, returning the prior
/// value of the limit. /// value of the limit.
#[inline] #[inline]
#[cfg_attr(docsrs, doc(cfg(feature = "limits")))] #[cfg_attr(docsrs, doc(cfg(feature = "limits")))]
pub fn set_limit(&self, limit: Limit, new_val: i32) -> i32 { pub fn set_limit(&self, limit: Limit, new_val: i32) -> Result<i32> {
if new_val < 0 {
return Err(Error::SqliteFailure(
ffi::Error::new(ffi::SQLITE_RANGE),
Some(format!("{new_val} is invalid")),
));
}
let c = self.db.borrow_mut(); let c = self.db.borrow_mut();
unsafe { ffi::sqlite3_limit(c.db(), limit as c_int, new_val) } let rc = unsafe { ffi::sqlite3_limit(c.db(), limit as c_int, new_val) };
if rc < 0 {
return Err(Error::SqliteFailure(
ffi::Error::new(ffi::SQLITE_RANGE),
Some(format!("{limit:?} is invalid")),
));
}
Ok(rc)
} }
} }
@ -106,12 +129,10 @@ mod test {
Limit::SQLITE_LIMIT_VARIABLE_NUMBER as i32, Limit::SQLITE_LIMIT_VARIABLE_NUMBER as i32,
ffi::SQLITE_LIMIT_VARIABLE_NUMBER, ffi::SQLITE_LIMIT_VARIABLE_NUMBER,
); );
#[cfg(feature = "bundled")]
assert_eq!( assert_eq!(
Limit::SQLITE_LIMIT_TRIGGER_DEPTH as i32, Limit::SQLITE_LIMIT_TRIGGER_DEPTH as i32,
ffi::SQLITE_LIMIT_TRIGGER_DEPTH, ffi::SQLITE_LIMIT_TRIGGER_DEPTH,
); );
#[cfg(feature = "bundled")]
assert_eq!( assert_eq!(
Limit::SQLITE_LIMIT_WORKER_THREADS as i32, Limit::SQLITE_LIMIT_WORKER_THREADS as i32,
ffi::SQLITE_LIMIT_WORKER_THREADS, ffi::SQLITE_LIMIT_WORKER_THREADS,
@ -121,38 +142,44 @@ mod test {
#[test] #[test]
fn test_limit() -> Result<()> { fn test_limit() -> Result<()> {
let db = Connection::open_in_memory()?; let db = Connection::open_in_memory()?;
db.set_limit(Limit::SQLITE_LIMIT_LENGTH, 1024); db.set_limit(Limit::SQLITE_LIMIT_LENGTH, 1024)?;
assert_eq!(1024, db.limit(Limit::SQLITE_LIMIT_LENGTH)); assert_eq!(1024, db.limit(Limit::SQLITE_LIMIT_LENGTH)?);
db.set_limit(Limit::SQLITE_LIMIT_SQL_LENGTH, 1024); db.set_limit(Limit::SQLITE_LIMIT_SQL_LENGTH, 1024)?;
assert_eq!(1024, db.limit(Limit::SQLITE_LIMIT_SQL_LENGTH)); assert_eq!(1024, db.limit(Limit::SQLITE_LIMIT_SQL_LENGTH)?);
db.set_limit(Limit::SQLITE_LIMIT_COLUMN, 64); db.set_limit(Limit::SQLITE_LIMIT_COLUMN, 64)?;
assert_eq!(64, db.limit(Limit::SQLITE_LIMIT_COLUMN)); assert_eq!(64, db.limit(Limit::SQLITE_LIMIT_COLUMN)?);
db.set_limit(Limit::SQLITE_LIMIT_EXPR_DEPTH, 256); db.set_limit(Limit::SQLITE_LIMIT_EXPR_DEPTH, 256)?;
assert_eq!(256, db.limit(Limit::SQLITE_LIMIT_EXPR_DEPTH)); assert_eq!(256, db.limit(Limit::SQLITE_LIMIT_EXPR_DEPTH)?);
db.set_limit(Limit::SQLITE_LIMIT_COMPOUND_SELECT, 32); db.set_limit(Limit::SQLITE_LIMIT_COMPOUND_SELECT, 32)?;
assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_COMPOUND_SELECT)); assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_COMPOUND_SELECT)?);
db.set_limit(Limit::SQLITE_LIMIT_FUNCTION_ARG, 32); db.set_limit(Limit::SQLITE_LIMIT_FUNCTION_ARG, 32)?;
assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_FUNCTION_ARG)); assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_FUNCTION_ARG)?);
db.set_limit(Limit::SQLITE_LIMIT_ATTACHED, 2); db.set_limit(Limit::SQLITE_LIMIT_ATTACHED, 2)?;
assert_eq!(2, db.limit(Limit::SQLITE_LIMIT_ATTACHED)); assert_eq!(2, db.limit(Limit::SQLITE_LIMIT_ATTACHED)?);
db.set_limit(Limit::SQLITE_LIMIT_LIKE_PATTERN_LENGTH, 128); db.set_limit(Limit::SQLITE_LIMIT_LIKE_PATTERN_LENGTH, 128)?;
assert_eq!(128, db.limit(Limit::SQLITE_LIMIT_LIKE_PATTERN_LENGTH)); assert_eq!(128, db.limit(Limit::SQLITE_LIMIT_LIKE_PATTERN_LENGTH)?);
db.set_limit(Limit::SQLITE_LIMIT_VARIABLE_NUMBER, 99); db.set_limit(Limit::SQLITE_LIMIT_VARIABLE_NUMBER, 99)?;
assert_eq!(99, db.limit(Limit::SQLITE_LIMIT_VARIABLE_NUMBER)); assert_eq!(99, db.limit(Limit::SQLITE_LIMIT_VARIABLE_NUMBER)?);
db.set_limit(Limit::SQLITE_LIMIT_TRIGGER_DEPTH, 32); db.set_limit(Limit::SQLITE_LIMIT_TRIGGER_DEPTH, 32)?;
assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_TRIGGER_DEPTH)); assert_eq!(32, db.limit(Limit::SQLITE_LIMIT_TRIGGER_DEPTH)?);
db.set_limit(Limit::SQLITE_LIMIT_WORKER_THREADS, 2); db.set_limit(Limit::SQLITE_LIMIT_WORKER_THREADS, 2)?;
assert_eq!(2, db.limit(Limit::SQLITE_LIMIT_WORKER_THREADS)); assert_eq!(2, db.limit(Limit::SQLITE_LIMIT_WORKER_THREADS)?);
assert!(db
.set_limit(Limit::SQLITE_LIMIT_WORKER_THREADS, -1)
.is_err());
assert!(db.set_limit(Limit::INVALID, 0).is_err());
assert!(db.limit(Limit::INVALID).is_err());
Ok(()) Ok(())
} }
} }