Struct parity_db::Options

source ·
pub struct Options {
    pub path: PathBuf,
    pub columns: Vec<ColumnOptions>,
    pub sync_wal: bool,
    pub sync_data: bool,
    pub stats: bool,
    pub salt: Option<[u8; 32]>,
    pub compression_threshold: HashMap<ColId, u32>,
}
Expand description

Database configuration.

Fields§

§path: PathBuf

Database path.

§columns: Vec<ColumnOptions>

Column settings

§sync_wal: bool

fsync WAL to disk before committing any changes. Provides extra consistency guarantees. On by default.

§sync_data: bool

fsync/msync data to disk before removing logs. Provides crash resistance guarantee. On by default.

§stats: bool

Collect database statistics. May have effect on performance.

§salt: Option<[u8; 32]>

Override salt value. If None is specified salt is loaded from metadata or randomly generated when creating a new database.

§compression_threshold: HashMap<ColId, u32>

Minimal value size threshold to attempt compressing a value per column.

Optional. A sensible default is used if nothing is set for a given column.

Implementations§

source§

impl Options

source

pub fn with_columns(path: &Path, num_columns: u8) -> Options

source

pub fn write_metadata(&self, path: &Path, salt: &[u8; 32]) -> Result<()>

source

pub fn write_metadata_file(&self, path: &Path, salt: &[u8; 32]) -> Result<()>

source

pub fn write_metadata_with_version( &self, path: &Path, salt: &[u8; 32], version: Option<u32> ) -> Result<()>

source

pub fn write_metadata_file_with_version( &self, path: &Path, salt: &[u8; 32], version: Option<u32> ) -> Result<()>

source

pub fn load_and_validate_metadata(&self, create: bool) -> Result<Metadata>

source

pub fn load_metadata(path: &Path) -> Result<Option<Metadata>>

source

pub fn load_metadata_file(path: &Path) -> Result<Option<Metadata>>

source

pub fn is_valid(&self) -> bool

Trait Implementations§

source§

impl Clone for Options

source§

fn clone(&self) -> Options

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 Options

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> Same for T

§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V