Struct rocksdb::Env

source ·
pub struct Env(/* private fields */);
Expand description

An Env is an interface used by the rocksdb implementation to access operating system functionality like the filesystem etc. Callers may wish to provide a custom Env object when opening a database to get fine gain control; e.g., to rate limit file system operations.

All Env implementations are safe for concurrent access from multiple threads without any external synchronization.

Note: currently, C API behinds C++ API for various settings. See also: rocksdb/include/env.h

Implementations§

source§

impl Env

source

pub fn new() -> Result<Self, Error>

Returns default env

source

pub fn mem_env() -> Result<Self, Error>

Returns a new environment that stores its data in memory and delegates all non-file-storage tasks to base_env.

source

pub fn set_background_threads(&mut self, num_threads: c_int)

Sets the number of background worker threads of a specific thread pool for this environment. LOW is the default pool.

Default: 1

source

pub fn set_high_priority_background_threads(&mut self, n: c_int)

Sets the size of the high priority thread pool that can be used to prevent compactions from stalling memtable flushes.

source

pub fn set_low_priority_background_threads(&mut self, n: c_int)

Sets the size of the low priority thread pool that can be used to prevent compactions from stalling memtable flushes.

source

pub fn set_bottom_priority_background_threads(&mut self, n: c_int)

Sets the size of the bottom priority thread pool that can be used to prevent compactions from stalling memtable flushes.

source

pub fn join_all_threads(&mut self)

Wait for all threads started by StartThread to terminate.

source

pub fn lower_thread_pool_io_priority(&mut self)

Lowering IO priority for threads from the specified pool.

source

pub fn lower_high_priority_thread_pool_io_priority(&mut self)

Lowering IO priority for high priority thread pool.

source

pub fn lower_thread_pool_cpu_priority(&mut self)

Lowering CPU priority for threads from the specified pool.

source

pub fn lower_high_priority_thread_pool_cpu_priority(&mut self)

Lowering CPU priority for high priority thread pool.

Trait Implementations§

source§

impl Clone for Env

source§

fn clone(&self) -> Env

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

Auto Trait Implementations§

§

impl Freeze for Env

§

impl RefUnwindSafe for Env

§

impl Send for Env

§

impl Sync for Env

§

impl Unpin for Env

§

impl UnwindSafe for Env

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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)

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.