#[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
sourceimpl 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)
sourcepub const fn from_bits(bits: c_int) -> Option<Self>
pub const fn from_bits(bits: c_int) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: c_int) -> Self
pub const fn from_bits_truncate(bits: c_int) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: c_int) -> Self
pub const unsafe fn from_bits_unchecked(bits: c_int) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl BitAndAssign<OpenFlags> for OpenFlags
impl BitAndAssign<OpenFlags> for OpenFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOrAssign<OpenFlags> for OpenFlags
impl BitOrAssign<OpenFlags> for OpenFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXorAssign<OpenFlags> for OpenFlags
impl BitXorAssign<OpenFlags> for OpenFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Extend<OpenFlags> for OpenFlags
impl Extend<OpenFlags> for OpenFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<OpenFlags> for OpenFlags
impl FromIterator<OpenFlags> for OpenFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Ord for OpenFlags
impl Ord for OpenFlags
sourceimpl PartialOrd<OpenFlags> for OpenFlags
impl PartialOrd<OpenFlags> for OpenFlags
sourcefn partial_cmp(&self, other: &OpenFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &OpenFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl SubAssign<OpenFlags> for OpenFlags
impl SubAssign<OpenFlags> for OpenFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
impl Copy for OpenFlags
impl Eq for OpenFlags
impl StructuralEq for OpenFlags
impl StructuralPartialEq for OpenFlags
Auto Trait Implementations
impl RefUnwindSafe for OpenFlags
impl Send for OpenFlags
impl Sync for OpenFlags
impl Unpin for OpenFlags
impl UnwindSafe for OpenFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more