Struct rusqlite::functions::FunctionFlags
source · [−]#[repr(C)]pub struct FunctionFlags { /* private fields */ }
functions
only.Expand description
Function Flags. See sqlite3_create_function and Function Flags for details.
Implementations
sourceimpl FunctionFlags
impl FunctionFlags
sourcepub const SQLITE_UTF8: Self = _
pub const SQLITE_UTF8: Self = _
Specifies UTF-8 as the text encoding this SQL function prefers for its parameters.
sourcepub const SQLITE_UTF16LE: Self = _
pub const SQLITE_UTF16LE: Self = _
Specifies UTF-16 using little-endian byte order as the text encoding this SQL function prefers for its parameters.
sourcepub const SQLITE_UTF16BE: Self = _
pub const SQLITE_UTF16BE: Self = _
Specifies UTF-16 using big-endian byte order as the text encoding this SQL function prefers for its parameters.
sourcepub const SQLITE_UTF16: Self = _
pub const SQLITE_UTF16: Self = _
Specifies UTF-16 using native byte order as the text encoding this SQL function prefers for its parameters.
sourcepub const SQLITE_DETERMINISTIC: Self = _
pub const SQLITE_DETERMINISTIC: Self = _
Means that the function always gives the same output when the input parameters are the same.
sourcepub const SQLITE_DIRECTONLY: Self = _
pub const SQLITE_DIRECTONLY: Self = _
Means that the function may only be invoked from top-level SQL.
sourcepub const SQLITE_SUBTYPE: Self = _
pub const SQLITE_SUBTYPE: Self = _
Indicates to SQLite that a function may call sqlite3_value_subtype()
to inspect the sub-types of its arguments.
sourcepub const SQLITE_INNOCUOUS: Self = _
pub const SQLITE_INNOCUOUS: Self = _
Means that the function is unlikely to cause problems even if misused.
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 Binary for FunctionFlags
impl Binary for FunctionFlags
sourceimpl BitAnd<FunctionFlags> for FunctionFlags
impl BitAnd<FunctionFlags> for FunctionFlags
type Output = FunctionFlags
type Output = FunctionFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<FunctionFlags> for FunctionFlags
impl BitAndAssign<FunctionFlags> for FunctionFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<FunctionFlags> for FunctionFlags
impl BitOr<FunctionFlags> for FunctionFlags
sourcefn bitor(self, other: FunctionFlags) -> Self
fn bitor(self, other: FunctionFlags) -> Self
Returns the union of the two sets of flags.
type Output = FunctionFlags
type Output = FunctionFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<FunctionFlags> for FunctionFlags
impl BitOrAssign<FunctionFlags> for FunctionFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<FunctionFlags> for FunctionFlags
impl BitXor<FunctionFlags> for FunctionFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = FunctionFlags
type Output = FunctionFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<FunctionFlags> for FunctionFlags
impl BitXorAssign<FunctionFlags> for FunctionFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for FunctionFlags
impl Clone for FunctionFlags
sourcefn clone(&self) -> FunctionFlags
fn clone(&self) -> FunctionFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for FunctionFlags
impl Debug for FunctionFlags
sourceimpl Default for FunctionFlags
impl Default for FunctionFlags
sourcefn default() -> FunctionFlags
fn default() -> FunctionFlags
Returns the “default value” for a type. Read more
sourceimpl Extend<FunctionFlags> for FunctionFlags
impl Extend<FunctionFlags> for FunctionFlags
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<FunctionFlags> for FunctionFlags
impl FromIterator<FunctionFlags> for FunctionFlags
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 Hash for FunctionFlags
impl Hash for FunctionFlags
sourceimpl LowerHex for FunctionFlags
impl LowerHex for FunctionFlags
sourceimpl Not for FunctionFlags
impl Not for FunctionFlags
type Output = FunctionFlags
type Output = FunctionFlags
The resulting type after applying the !
operator.
sourceimpl Octal for FunctionFlags
impl Octal for FunctionFlags
sourceimpl Ord for FunctionFlags
impl Ord for FunctionFlags
sourceimpl PartialEq<FunctionFlags> for FunctionFlags
impl PartialEq<FunctionFlags> for FunctionFlags
sourcefn eq(&self, other: &FunctionFlags) -> bool
fn eq(&self, other: &FunctionFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &FunctionFlags) -> bool
fn ne(&self, other: &FunctionFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<FunctionFlags> for FunctionFlags
impl PartialOrd<FunctionFlags> for FunctionFlags
sourcefn partial_cmp(&self, other: &FunctionFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &FunctionFlags) -> 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 Sub<FunctionFlags> for FunctionFlags
impl Sub<FunctionFlags> for FunctionFlags
type Output = FunctionFlags
type Output = FunctionFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<FunctionFlags> for FunctionFlags
impl SubAssign<FunctionFlags> for FunctionFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for FunctionFlags
impl UpperHex for FunctionFlags
impl Copy for FunctionFlags
impl Eq for FunctionFlags
impl StructuralEq for FunctionFlags
impl StructuralPartialEq for FunctionFlags
Auto Trait Implementations
impl RefUnwindSafe for FunctionFlags
impl Send for FunctionFlags
impl Sync for FunctionFlags
impl Unpin for FunctionFlags
impl UnwindSafe for FunctionFlags
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