Struct rkv::WriteFlags

pub struct WriteFlags { /* fields omitted */ }

Write options.

Methods

impl WriteFlags

pub const NO_OVERWRITE: WriteFlags

Insert the new item only if the key does not already appear in the database. The function will return LmdbError::KeyExist if the key already appears in the database, even if the database supports duplicates (DUP_SORT).

pub const NO_DUP_DATA: WriteFlags

Insert the new item only if it does not already appear in the database. This flag may only be specified if the database was opened with DUP_SORT. The function will return LmdbError::KeyExist if the item already appears in the database.

pub const CURRENT: WriteFlags

For Cursor::put. Replace the item at the current cursor position. The key parameter must match the current position. If using sorted duplicates (DUP_SORT) the data item must still sort into the same position. This is intended to be used when the new data is the same size as the old. Otherwise it will simply perform a delete of the old record followed by an insert.

pub const APPEND: WriteFlags

Append the given item to the end of the database. No key comparisons are performed. This option allows fast bulk loading when keys are already known to be in the correct order. Loading unsorted keys with this flag will cause data corruption.

pub const APPEND_DUP: WriteFlags

Same as APPEND, but for sorted dup data.

pub const fn empty() -> WriteFlags

Returns an empty set of flags

pub const fn all() -> WriteFlags

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<WriteFlags>

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) -> WriteFlags

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl BitOrAssign<WriteFlags> for WriteFlags

fn bitor_assign(&mut self, other: WriteFlags)

Adds the set of flags.

impl SubAssign<WriteFlags> for WriteFlags

fn sub_assign(&mut self, other: WriteFlags)

Disables all flags enabled in the set.

impl BitOr<WriteFlags> for WriteFlags

type Output = WriteFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<WriteFlags> for WriteFlags

type Output = WriteFlags

The resulting type after applying the ^ operator.

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

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

impl Not for WriteFlags

type Output = WriteFlags

The resulting type after applying the ! operator.

fn not(self) -> WriteFlags

Returns the complement of this set of flags.

impl Eq for WriteFlags

impl BitAndAssign<WriteFlags> for WriteFlags

fn bitand_assign(&mut self, other: WriteFlags)

Disables all flags disabled in the set.

impl Debug for WriteFlags

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

Formats the value using the given formatter.

impl PartialEq<WriteFlags> for WriteFlags

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

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

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

This method tests for !=.

impl LowerHex for WriteFlags

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

Formats the value using the given formatter.

impl Sub<WriteFlags> for WriteFlags

type Output = WriteFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl Extend<WriteFlags> for WriteFlags

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

Extends a collection with the contents of an iterator.

impl PartialOrd<WriteFlags> for WriteFlags

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

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

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

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

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

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

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

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

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

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

impl Ord for WriteFlags

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

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

Formats the value using the given formatter.

impl Clone for WriteFlags

fn clone(&self) -> WriteFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Binary for WriteFlags

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

Formats the value using the given formatter.

impl BitAnd<WriteFlags> for WriteFlags

type Output = WriteFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl FromIterator<WriteFlags> for WriteFlags

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

Creates a value from an iterator.

impl Default for WriteFlags

fn default() -> WriteFlags

Returns the "default value" for a type.

impl Octal for WriteFlags

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

Formats the value using the given formatter.

impl Hash for WriteFlags

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<WriteFlags> for WriteFlags

fn bitxor_assign(&mut self, other: WriteFlags)

Toggles the set of flags.

impl Copy for WriteFlags