Struct rusqlite::OpenFlags

#[repr(C)]
pub struct OpenFlags(/* private fields */);

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

impl OpenFlags

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.

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.

pub const SQLITE_OPEN_CREATE: Self = _

The database is created if it does not already exist

pub const SQLITE_OPEN_URI: Self = _

The filename can be interpreted as a URI if this flag is set.

pub const SQLITE_OPEN_MEMORY: Self = _

The database will be opened as an in-memory database.

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.

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.

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.

pub const SQLITE_OPEN_PRIVATE_CACHE: Self = _

The database is opened shared cache disabled.

pub const SQLITE_OPEN_NOFOLLOW: Self = _

The database filename is not allowed to be a symbolic link. (3.31.0)

pub const SQLITE_OPEN_EXRESCODE: Self = _

Extended result codes. (3.37.0)

impl OpenFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> c_int

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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.

pub const fn from_bits_truncate(bits: c_int) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: c_int) -> Self

Convert from a bits value exactly.

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.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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.

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.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

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.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

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.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl 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.

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

impl Binary for OpenFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for OpenFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = OpenFlags

The resulting type after applying the & operator.

impl BitAndAssign for OpenFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for OpenFlags

fn bitor(self, other: OpenFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = OpenFlags

The resulting type after applying the | operator.

impl BitOrAssign for OpenFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for OpenFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = OpenFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for OpenFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for OpenFlags

fn clone(&self) -> OpenFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenFlags

fn default() -> OpenFlags

Returns the “default value” for a type.

impl Extend<OpenFlags> for OpenFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for OpenFlags

const FLAGS: &'static [Flag<OpenFlags>] = _

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> c_int

Get the underlying bits value.

fn from_bits_retain(bits: c_int) -> OpenFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<OpenFlags> for OpenFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for OpenFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for OpenFlags

type Item = OpenFlags

The type of the elements being iterated over.

type IntoIter = Iter<OpenFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for OpenFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for OpenFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = OpenFlags

The resulting type after applying the ! operator.

impl Octal for OpenFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OpenFlags

fn eq(&self, other: &OpenFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PublicFlags for OpenFlags

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for OpenFlags

fn sub(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.

type Output = OpenFlags

The resulting type after applying the - operator.

impl SubAssign for OpenFlags

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.

impl UpperHex for OpenFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for OpenFlags

impl Eq for OpenFlags

impl StructuralPartialEq for OpenFlags