Struct BoltOptionsBuilder

pub struct BoltOptionsBuilder<TypedBuilderFields = ((), (), (), (), (), (), ())> { /* private fields */ }

Builder for BoltOptions instances.

See BoltOptions::builder() for more info.

Implementations

impl<__initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay> BoltOptionsBuilder<((), __initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay)>

pub fn preload_freelist( self, ) -> BoltOptionsBuilder<((bool,), __initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay)>

Sets whether to load the free pages when opening the db file.Note when opening db in write mode, bbolt will always load the free pages.

impl<__preload_freelist, __page_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay> BoltOptionsBuilder<(__preload_freelist, (), __page_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay)>

pub fn initial_mmap_size( self, initial_mmap_size: u64, ) -> BoltOptionsBuilder<(__preload_freelist, (Option<u64>,), __page_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay)>

InitialMmapSize is the initial mmap size of the database in bytes. Read transactions won’t block write transaction if the InitialMmapSize is large enough to hold database mmap size.

impl<__preload_freelist, __initial_mmap_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, (), __no_sync, __mlock, __max_batch_size, __max_batch_delay)>

pub fn page_size( self, page_size: usize, ) -> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, (Option<usize>,), __no_sync, __mlock, __max_batch_size, __max_batch_delay)>

PageSize overrides the default OS page size.

impl<__preload_freelist, __initial_mmap_size, __page_size, __mlock, __max_batch_size, __max_batch_delay> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, (), __mlock, __max_batch_size, __max_batch_delay)>

pub fn no_sync( self, ) -> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, (bool,), __mlock, __max_batch_size, __max_batch_delay)>

NoSync sets the initial value of DB.NoSync. Normally this can just be set directly on the DB itself when returned from Open(), but this option is useful in APIs which expose Options but not the underlying DB.

impl<__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __max_batch_size, __max_batch_delay> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, __no_sync, (), __max_batch_size, __max_batch_delay)>

pub fn mlock( self, ) -> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, __no_sync, (bool,), __max_batch_size, __max_batch_delay)>

Mlock locks database file in memory when set to true. It prevents potential page faults, however used memory can’t be reclaimed. (UNIX only)

impl<__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_delay> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __mlock, (), __max_batch_delay)>

pub fn max_batch_size( self, max_batch_size: u32, ) -> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __mlock, (Option<u32>,), __max_batch_delay)>

max_batch_size is the maximum size of a batch.

impl<__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_size> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_size, ())>

pub fn max_batch_delay( self, max_batch_delay: Duration, ) -> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_size, (Option<Duration>,))>

max_batch_delay is the maximum delay before a batch starts.

impl<__preload_freelist: Optional<bool>, __initial_mmap_size: Optional<Option<u64>>, __page_size: Optional<Option<usize>>, __no_sync: Optional<bool>, __mlock: Optional<bool>, __max_batch_size: Optional<Option<u32>>, __max_batch_delay: Optional<Option<Duration>>> BoltOptionsBuilder<(__preload_freelist, __initial_mmap_size, __page_size, __no_sync, __mlock, __max_batch_size, __max_batch_delay)>

pub fn build(self) -> BoltOptions

Finalise the builder and create its BoltOptions instance

Trait Implementations

impl<TypedBuilderFields> Clone for BoltOptionsBuilder<TypedBuilderFields>

where TypedBuilderFields: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.