#[repr(C)]pub struct OpenFlags(/* private fields */);
Expand description
Flags for opening SQLite database connections. See sqlite3_open_v2 for details.
The default open flags are SQLITE_OPEN_READ_WRITE | SQLITE_OPEN_CREATE | SQLITE_OPEN_URI | SQLITE_OPEN_NO_MUTEX
. See Connection::open
for
some discussion about these flags.
Implementations§
Source§impl OpenFlags
impl OpenFlags
Sourcepub const SQLITE_OPEN_READ_ONLY: Self = _
pub const SQLITE_OPEN_READ_ONLY: Self = _
The database is opened in read-only mode. If the database does not already exist, an error is returned.
Sourcepub const SQLITE_OPEN_READ_WRITE: Self = _
pub const SQLITE_OPEN_READ_WRITE: Self = _
The database is opened for reading and writing if possible, or reading only if the file is write-protected by the operating system. In either case the database must already exist, otherwise an error is returned.
Sourcepub const SQLITE_OPEN_CREATE: Self = _
pub const SQLITE_OPEN_CREATE: Self = _
The database is created if it does not already exist
Sourcepub const SQLITE_OPEN_URI: Self = _
pub const SQLITE_OPEN_URI: Self = _
The filename can be interpreted as a URI if this flag is set.
Sourcepub const SQLITE_OPEN_MEMORY: Self = _
pub const SQLITE_OPEN_MEMORY: Self = _
The database will be opened as an in-memory database.
Sourcepub const SQLITE_OPEN_NO_MUTEX: Self = _
pub const SQLITE_OPEN_NO_MUTEX: Self = _
The new database connection will not use a per-connection mutex (the connection will use the “multi-thread” threading mode, in SQLite parlance).
This is used by default, as proper Send
/Sync
usage (in
particular, the fact that Connection
does not implement Sync
)
ensures thread-safety without the need to perform locking around all
calls.
Sourcepub const SQLITE_OPEN_FULL_MUTEX: Self = _
pub const SQLITE_OPEN_FULL_MUTEX: Self = _
The new database connection will use a per-connection mutex – the “serialized” threading mode, in SQLite parlance.
§Caveats
This flag should probably never be used with rusqlite
, as we
ensure thread-safety statically (we implement Send
and not
Sync
). That said
Critically, even if this flag is used, the Connection
is not
safe to use across multiple threads simultaneously. To access a
database from multiple threads, you should either create multiple
connections, one for each thread (if you have very many threads,
wrapping the rusqlite::Connection
in a mutex is also reasonable).
This is both because of the additional per-connection state stored
by rusqlite
(for example, the prepared statement cache), and
because not all of SQLites functions are fully thread safe, even in
serialized/SQLITE_OPEN_FULLMUTEX
mode.
All that said, it’s fairly harmless to enable this flag with
rusqlite
, it will just slow things down while providing no
benefit.
Sourcepub const SQLITE_OPEN_SHARED_CACHE: Self = _
pub const SQLITE_OPEN_SHARED_CACHE: Self = _
The database is opened with shared cache enabled.
This is frequently useful for in-memory connections, but note that broadly speaking it’s discouraged by SQLite itself, which states “Any use of shared cache is discouraged” in the official documentation.
Sourcepub const SQLITE_OPEN_PRIVATE_CACHE: Self = _
pub const SQLITE_OPEN_PRIVATE_CACHE: Self = _
The database is opened shared cache disabled.
Sourcepub const SQLITE_OPEN_NOFOLLOW: Self = _
pub const SQLITE_OPEN_NOFOLLOW: Self = _
The database filename is not allowed to be a symbolic link. (3.31.0)
Sourcepub const SQLITE_OPEN_EXRESCODE: Self = _
pub const SQLITE_OPEN_EXRESCODE: Self = _
Extended result codes. (3.37.0)
Source§impl OpenFlags
impl OpenFlags
Sourcepub const fn bits(&self) -> c_int
pub const fn bits(&self) -> c_int
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: c_int) -> Option<Self>
pub const fn from_bits(bits: c_int) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: c_int) -> Self
pub const fn from_bits_truncate(bits: c_int) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: c_int) -> Self
pub const fn from_bits_retain(bits: c_int) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl OpenFlags
impl OpenFlags
Sourcepub const fn iter(&self) -> Iter<OpenFlags>
pub const fn iter(&self) -> Iter<OpenFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
Sourcepub const fn iter_names(&self) -> IterNames<OpenFlags>
pub const fn iter_names(&self) -> IterNames<OpenFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
Source§impl BitAndAssign for OpenFlags
impl BitAndAssign for OpenFlags
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOrAssign for OpenFlags
impl BitOrAssign for OpenFlags
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXorAssign for OpenFlags
impl BitXorAssign for OpenFlags
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Extend<OpenFlags> for OpenFlags
impl Extend<OpenFlags> for OpenFlags
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Source§impl Flags for OpenFlags
impl Flags for OpenFlags
Source§fn from_bits_retain(bits: c_int) -> OpenFlags
fn from_bits_retain(bits: c_int) -> OpenFlags
Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.Source§impl FromIterator<OpenFlags> for OpenFlags
impl FromIterator<OpenFlags> for OpenFlags
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
Source§impl IntoIterator for OpenFlags
impl IntoIterator for OpenFlags
Source§impl Sub for OpenFlags
impl Sub for OpenFlags
Source§impl SubAssign for OpenFlags
impl SubAssign for OpenFlags
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.