Struct Config

pub struct Config(/* private fields */);

Top-level configuration for the system.

Examples

let _config = sled::Config::default()
    .path("/path/to/data".to_owned())
    .cache_capacity(10_000_000_000)
    .flush_every_ms(Some(1000));

Implementations

impl Config

pub fn new() -> Config

Returns a default Config

Examples found in repository

examples/basic.rs (line 6)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Creating a temporary sled database.
    // If you want to persist the data use sled::open instead.
    let db = sled::Config::new().temporary(true).open().unwrap();

    // The id is used by sled to identify which Tree in the database (db) to open
    let tree = bincode_sled::Tree::<String, SomeValue>::open(&db, "unique_id");

    tree.insert(&"some_key".to_owned(), &SomeValue(10))?;

    assert_eq!(tree.get(&"some_key".to_owned())?, Some(SomeValue(10)));
    Ok(())
}

pub fn path<P>(self, path: P) -> Config

where P: AsRef<Path>,

Set the path of the database (builder).

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

Opens a Db based on the provided config.

Examples found in repository

examples/basic.rs (line 6)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Creating a temporary sled database.
    // If you want to persist the data use sled::open instead.
    let db = sled::Config::new().temporary(true).open().unwrap();

    // The id is used by sled to identify which Tree in the database (db) to open
    let tree = bincode_sled::Tree::<String, SomeValue>::open(&db, "unique_id");

    tree.insert(&"some_key".to_owned(), &SomeValue(10))?;

    assert_eq!(tree.get(&"some_key".to_owned())?, Some(SomeValue(10)));
    Ok(())
}

pub fn cache_capacity(self, to: u64) -> Config

maximum size in bytes for the system page cache

pub fn mode(self, to: Mode) -> Config

specify whether the system should run in “small” or “fast” mode

pub fn use_compression(self, to: bool) -> Config

whether to use zstd compression

pub fn compression_factor(self, to: i32) -> Config

the compression factor to use with zstd compression. Ranges from 1 up to 22. Levels >= 20 are ‘ultra’.

pub fn temporary(self, to: bool) -> Config

deletes the database after drop. if no path is set, uses /dev/shm on linux

Examples found in repository

examples/basic.rs (line 6)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Creating a temporary sled database.
    // If you want to persist the data use sled::open instead.
    let db = sled::Config::new().temporary(true).open().unwrap();

    // The id is used by sled to identify which Tree in the database (db) to open
    let tree = bincode_sled::Tree::<String, SomeValue>::open(&db, "unique_id");

    tree.insert(&"some_key".to_owned(), &SomeValue(10))?;

    assert_eq!(tree.get(&"some_key".to_owned())?, Some(SomeValue(10)));
    Ok(())
}

pub fn create_new(self, to: bool) -> Config

attempts to exclusively open the database, failing if it already exists

pub fn print_profile_on_drop(self, to: bool) -> Config

print a performance profile when the Config is dropped

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl Deref for Config

type Target = Inner

The resulting type after dereferencing.

fn deref(&self) -> &Inner

Dereferences the value.