Struct nimiq_database::DatabaseFlags

pub struct DatabaseFlags { /* fields omitted */ }

Methods

impl DatabaseFlags

pub const DUPLICATE_KEYS: DatabaseFlags

Duplicate keys may be used in the database.

pub const DUP_FIXED_SIZE_VALUES: DatabaseFlags

This flag may only be used in combination with DUPLICATE_KEYS. This option tells the database that the values for this database are all the same size.

pub const UINT_KEYS: DatabaseFlags

Keys are binary integers in native byte order and will be sorted as such (std::os::raw::c_uint, i.e. most likely u32).

pub const DUP_UINT_VALUES: DatabaseFlags

This option specifies that duplicate data items are binary integers, similar to UINT_KEYS keys.

pub const fn empty() -> DatabaseFlags

Returns an empty set of flags

pub const fn all() -> DatabaseFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<DatabaseFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> DatabaseFlags

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> DatabaseFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: DatabaseFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Extend<DatabaseFlags> for DatabaseFlags

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

Extends a collection with the contents of an iterator.

impl Clone for DatabaseFlags

fn clone(&self) -> DatabaseFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DatabaseFlags

impl Default for DatabaseFlags

fn default() -> DatabaseFlags

Returns the "default value" for a type.

impl Eq for DatabaseFlags

impl Ord for DatabaseFlags

fn cmp(&self, other: &DatabaseFlags) -> 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) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<DatabaseFlags> for DatabaseFlags

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

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

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

This method tests for !=.

impl PartialOrd<DatabaseFlags> for DatabaseFlags

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

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

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

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

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

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

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

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

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

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

impl Debug for DatabaseFlags

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

Formats the value using the given formatter.

impl Sub<DatabaseFlags> for DatabaseFlags

type Output = DatabaseFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<DatabaseFlags> for DatabaseFlags

fn sub_assign(&mut self, other: DatabaseFlags)

Disables all flags enabled in the set.

impl Not for DatabaseFlags

type Output = DatabaseFlags

The resulting type after applying the ! operator.

fn not(self) -> DatabaseFlags

Returns the complement of this set of flags.

impl BitAnd<DatabaseFlags> for DatabaseFlags

type Output = DatabaseFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<DatabaseFlags> for DatabaseFlags

type Output = DatabaseFlags

The resulting type after applying the | operator.

fn bitor(self, other: DatabaseFlags) -> DatabaseFlags

Returns the union of the two sets of flags.

impl BitXor<DatabaseFlags> for DatabaseFlags

type Output = DatabaseFlags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<DatabaseFlags> for DatabaseFlags

fn bitand_assign(&mut self, other: DatabaseFlags)

Disables all flags disabled in the set.

impl BitOrAssign<DatabaseFlags> for DatabaseFlags

fn bitor_assign(&mut self, other: DatabaseFlags)

Adds the set of flags.

impl BitXorAssign<DatabaseFlags> for DatabaseFlags

fn bitxor_assign(&mut self, other: DatabaseFlags)

Toggles the set of flags.

impl Hash for DatabaseFlags

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 StructuralPartialEq for DatabaseFlags

impl StructuralEq for DatabaseFlags

impl FromIterator<DatabaseFlags> for DatabaseFlags

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

Creates a value from an iterator.

impl Octal for DatabaseFlags

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

Formats the value using the given formatter.

impl Binary for DatabaseFlags

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

Formats the value using the given formatter.

impl LowerHex for DatabaseFlags

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

Formats the value using the given formatter.

impl UpperHex for DatabaseFlags

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

Formats the value using the given formatter.