Struct rkv::DatabaseFlags

pub struct DatabaseFlags { /* fields omitted */ }

Database options.

Methods

impl DatabaseFlags

pub const REVERSE_KEY: DatabaseFlags

Keys are strings to be compared in reverse order, from the end of the strings to the beginning. By default, Keys are treated as strings and compared from beginning to end.

pub const DUP_SORT: DatabaseFlags

Duplicate keys may be used in the database. (Or, from another perspective, keys may have multiple data items, stored in sorted order.) By default keys must be unique and may have only a single data item.

pub const INTEGER_KEY: DatabaseFlags

Keys are binary integers in native byte order. Setting this option requires all keys to be the same size, typically 32 or 64 bits.

pub const DUP_FIXED: DatabaseFlags

This flag may only be used in combination with DUP_SORT. This option tells the library that the data items for this database are all the same size, which allows further optimizations in storage and retrieval. When all data items are the same size, the GET_MULTIPLE and NEXT_MULTIPLE cursor operations may be used to retrieve multiple items at once.

pub const INTEGER_DUP: DatabaseFlags

This option specifies that duplicate data items are also integers, and should be sorted as such.

pub const REVERSE_DUP: DatabaseFlags

This option specifies that duplicate data items should be compared as strings in reverse order.

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

fn bitor_assign(&mut self, other: DatabaseFlags)

Adds the set of flags.

impl SubAssign<DatabaseFlags> for DatabaseFlags

fn sub_assign(&mut self, other: DatabaseFlags)

Disables all flags enabled in the set.

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

impl BitAndAssign<DatabaseFlags> for DatabaseFlags

fn bitand_assign(&mut self, other: DatabaseFlags)

Disables all flags disabled in the set.

impl Debug for DatabaseFlags

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

Formats the value using the given formatter.

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

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

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

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

Extends a collection with the contents of an iterator.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Creates a value from an iterator.

impl Default for DatabaseFlags

fn default() -> DatabaseFlags

Returns the "default value" for a type.

impl Octal for DatabaseFlags

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

Formats the value using the given formatter.

impl Hash for DatabaseFlags

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

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

fn bitxor_assign(&mut self, other: DatabaseFlags)

Toggles the set of flags.

impl Copy for DatabaseFlags