Struct ejdb::DatabaseOpenMode

pub struct DatabaseOpenMode { /* fields omitted */ }

Several bit flags defining how an EJDB database should be opened.

This type has Default implementation which returns the most common set of open mode flags:

assert_eq!(
    DatabaseOpenMode::default(),
    DatabaseOpenMode::READ | DatabaseOpenMode::WRITE | DatabaseOpenMode::CREATE
);

This default set of flags is used by Database::open() static method.

Methods

impl DatabaseOpenMode

pub const READ: DatabaseOpenMode

Open the database in read-only mode.

pub const WRITE: DatabaseOpenMode

Open the database in write-only mode.

pub const CREATE: DatabaseOpenMode

Create the database file if it does not exist.

pub const TRUNCATE: DatabaseOpenMode

Truncate the database after opening it.

pub const NO_LOCK: DatabaseOpenMode

Open the database without locking.

pub const LOCK_WITHOUT_BLOCKING: DatabaseOpenMode

Lock the database without blocking.

pub const SYNC: DatabaseOpenMode

Synchronize every transaction.

pub fn empty() -> DatabaseOpenMode

Returns an empty set of flags.

pub fn all() -> DatabaseOpenMode

Returns the set containing all flags.

pub fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

pub fn from_bits_truncate(bits: u32) -> DatabaseOpenMode

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl DatabaseOpenMode

pub fn open<P: Into<Vec<u8>>>(self, path: P) -> Result<Database>

Invokes Database::open_with_mode() with this mode and the provided path as arguments.

This is a convenient shortcut for creating database with non-default options.

Example

let db = (DatabaseOpenMode::default() | DatabaseOpenMode::TRUNCATE).open("path/to/db");
// equivalent to
let db = Database::open_with_mode(
    "path/to/db", DatabaseOpenMode::default() | DatabaseOpenMode::TRUNCATE
);

Trait Implementations

impl PartialEq<DatabaseOpenMode> for DatabaseOpenMode

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

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

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

This method tests for !=.

impl Default for DatabaseOpenMode

fn default() -> DatabaseOpenMode

Returns the "default value" for a type.

impl Ord for DatabaseOpenMode

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

impl Clone for DatabaseOpenMode

fn clone(&self) -> DatabaseOpenMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<DatabaseOpenMode> for DatabaseOpenMode

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

Extends a collection with the contents of an iterator.

impl Eq for DatabaseOpenMode

impl Copy for DatabaseOpenMode

impl PartialOrd<DatabaseOpenMode> for DatabaseOpenMode

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

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

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

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

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

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

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

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

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

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

impl Binary for DatabaseOpenMode

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

Formats the value using the given formatter.

impl Debug for DatabaseOpenMode

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

Formats the value using the given formatter.

impl UpperHex for DatabaseOpenMode

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

Formats the value using the given formatter.

impl LowerHex for DatabaseOpenMode

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

Formats the value using the given formatter.

impl Octal for DatabaseOpenMode

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

Formats the value using the given formatter.

impl Hash for DatabaseOpenMode

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 Sub<DatabaseOpenMode> for DatabaseOpenMode

type Output = DatabaseOpenMode

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<DatabaseOpenMode> for DatabaseOpenMode

fn sub_assign(&mut self, other: DatabaseOpenMode)

Disables all flags enabled in the set.

impl Not for DatabaseOpenMode

type Output = DatabaseOpenMode

The resulting type after applying the ! operator.

fn not(self) -> DatabaseOpenMode

Returns the complement of this set of flags.

impl BitAnd<DatabaseOpenMode> for DatabaseOpenMode

type Output = DatabaseOpenMode

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<DatabaseOpenMode> for DatabaseOpenMode

type Output = DatabaseOpenMode

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<DatabaseOpenMode> for DatabaseOpenMode

type Output = DatabaseOpenMode

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<DatabaseOpenMode> for DatabaseOpenMode

fn bitand_assign(&mut self, other: DatabaseOpenMode)

Disables all flags disabled in the set.

impl BitOrAssign<DatabaseOpenMode> for DatabaseOpenMode

fn bitor_assign(&mut self, other: DatabaseOpenMode)

Adds the set of flags.

impl BitXorAssign<DatabaseOpenMode> for DatabaseOpenMode

fn bitxor_assign(&mut self, other: DatabaseOpenMode)

Toggles the set of flags.

impl FromIterator<DatabaseOpenMode> for DatabaseOpenMode

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

Creates a value from an iterator.