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)

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

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.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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

impl Binary for OpenFlags

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

Formats the value using the given formatter.

impl BitAnd<OpenFlags> for OpenFlags

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

Returns the intersection between the two sets of flags.

type Output = OpenFlags

The resulting type after applying the & operator.

impl BitAndAssign<OpenFlags> for OpenFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<OpenFlags> for OpenFlags

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

Returns the union of the two sets of flags.

type Output = OpenFlags

The resulting type after applying the | operator.

impl BitOrAssign<OpenFlags> for OpenFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<OpenFlags> for OpenFlags

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

Returns the left flags, but with all the right flags toggled.

type Output = OpenFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<OpenFlags> for OpenFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

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)

Extends a collection with the contents of an iterator.

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 FromIterator<OpenFlags> for OpenFlags

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

Creates a value from an iterator.

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,

Feeds a slice of this type into the given Hasher.

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

Returns the complement of this set of flags.

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 Ord for OpenFlags

fn cmp(&self, other: &OpenFlags) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<OpenFlags> 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 PartialOrd<OpenFlags> for OpenFlags

fn partial_cmp(&self, other: &OpenFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<OpenFlags> for OpenFlags

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

Returns the set difference of the two sets of flags.

type Output = OpenFlags

The resulting type after applying the - operator.

impl SubAssign<OpenFlags> for OpenFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

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 StructuralEq for OpenFlags

impl StructuralPartialEq for OpenFlags