Struct mmtkvdb::EnvRo

source · [−]

pub struct EnvRo { /* private fields */ }

Expand description

Read-only handle for accessing environment that stores key-value databases

An environment can be opened using EnvBuilder.

Use EnvRo::open_db to retrieve database handles and EnvRo::txn_ro to start a read-only transaction.

It’s possible to clone the handle, in which case the environment will be closed when the last handle is dropped.

It’s also possible to create a read-only handle from a read-write handle (EnvRw) by invoking .clone(), which clones the referenced EnvRo through deref coercion (see example for EnvBuilder).

Implementations

source

impl EnvRo

source

pub fn txn_ro(&self) -> Result<TxnRo<'_>, Error>

Start read-only transaction

source

pub fn max_keysize(&self) -> usize

Get maximum size of keys and duplicate data

source

pub fn valid_keysize<'kr, K, KRef>(&self, key: KRef) -> bool where
K: ?Sized + Storable + 'kr,
KRef: StorableRef<'kr, K>,

Checks if key or duplicate data has valid size

source

pub unsafe fn open_dbs<'a, K, V, C>(
 &self,
 options: impl IntoIterator<IntoIter = impl Iterator<Item = &'a DbOptions<K, V, C, Option<CString>>> + ExactSizeIterator>
) -> Result<Vec<Db<K, V, C>>, Error> where
 K: ?Sized + Storable + 'a,
 V: ?Sized + Storable + 'a,
 C: Constraint,

Open databases in environment

SAFETY: If a database exists already, it must have been created with compatible options.

source

pub unsafe fn open_db<K, V, C>(
 &self,
 options: &DbOptions<K, V, C, Option<CString>>
) -> Result<Db<K, V, C>, Error> where
 K: ?Sized + Storable,
 V: ?Sized + Storable,
 C: Constraint,

Open database in environment

SAFETY: If a database exists already, it must have been created with compatible options.

source

pub fn clear_stale_readers(&self) -> Result<(), Error>

Clear stale readers

Refer to LMDB’s documentation when to clear stale readers

Trait Implementations

source

impl Clone for EnvRo

source

fn clone(&self) -> EnvRo

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for EnvRo

source

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

Formats the value using the given formatter. Read more

source

impl Hash for EnvRo

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<EnvRo> for EnvRo

source

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

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

source

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

This method tests for !=.

source

impl Eq for EnvRo

source

impl StructuralEq for EnvRo

source

impl StructuralPartialEq for EnvRo

Auto Trait Implementations

impl RefUnwindSafe for EnvRo

impl Send for EnvRo

impl Sync for EnvRo

impl Unpin for EnvRo

impl UnwindSafe for EnvRo

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct mmtkvdb::EnvRo

Implementations

impl EnvRo

pub fn txn_ro(&self) -> Result<TxnRo<'_>, Error>

pub fn max_keysize(&self) -> usize

pub fn valid_keysize<'kr, K, KRef>(&self, key: KRef) -> bool where K: ?Sized + Storable + 'kr, KRef: StorableRef<'kr, K>,

pub unsafe fn open_dbs<'a, K, V, C>( &self, options: impl IntoIterator<IntoIter = impl Iterator<Item = &'a DbOptions<K, V, C, Option<CString>>> + ExactSizeIterator>) -> Result<Vec<Db<K, V, C>>, Error> where K: ?Sized + Storable + 'a, V: ?Sized + Storable + 'a, C: Constraint,

pub unsafe fn open_db<K, V, C>( &self, options: &DbOptions<K, V, C, Option<CString>>) -> Result<Db<K, V, C>, Error> where K: ?Sized + Storable, V: ?Sized + Storable, C: Constraint,

pub fn clear_stale_readers(&self) -> Result<(), Error>

Trait Implementations

impl Clone for EnvRo

fn clone(&self) -> EnvRo

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

impl Debug for EnvRo

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

impl Hash for EnvRo

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

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl PartialEq<EnvRo> for EnvRo

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

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

impl Eq for EnvRo

impl StructuralEq for EnvRo

impl StructuralPartialEq for EnvRo

Auto Trait Implementations

impl RefUnwindSafe for EnvRo

impl Send for EnvRo

impl Sync for EnvRo

impl Unpin for EnvRo

impl UnwindSafe for EnvRo

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn valid_keysize<'kr, K, KRef>(&self, key: KRef) -> bool where
K: ?Sized + Storable + 'kr,
KRef: StorableRef<'kr, K>,

pub unsafe fn open_dbs<'a, K, V, C>(
&self,
options: impl IntoIterator<IntoIter = impl Iterator<Item = &'a DbOptions<K, V, C, Option<CString>>> + ExactSizeIterator>
) -> Result<Vec<Db<K, V, C>>, Error> where
K: ?Sized + Storable + 'a,
V: ?Sized + Storable + 'a,
C: Constraint,

pub unsafe fn open_db<K, V, C>(
&self,
options: &DbOptions<K, V, C, Option<CString>>
) -> Result<Db<K, V, C>, Error> where
K: ?Sized + Storable,
V: ?Sized + Storable,
C: Constraint,

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

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,