Struct ipfs_embed::StorageConfig
source · [−]pub struct StorageConfig {
pub path: Option<PathBuf>,
pub access_db_path: Option<PathBuf>,
pub cache_size_blocks: u64,
pub cache_size_bytes: u64,
pub gc_interval: Duration,
pub gc_min_blocks: usize,
pub gc_target_duration: Duration,
}
Expand description
Storage configuration.
Fields
path: Option<PathBuf>
The path to use for the block store. If it is None
an in-memory block
store will be used.
access_db_path: Option<PathBuf>
The path to use for the database that persists block accesses times for the LRU cache. If this is set to ‘None’, access times will not be persisted but just tracked in memory.
You can point this to the same file as the main block store, but this is not recommended.
cache_size_blocks: u64
The target number of blocks.
Up to this number, the store will retain everything even if not pinned. Once this number is exceeded, the store will run garbage collection of all unpinned blocks until the block criterion is met again.
To completely disable storing of non-pinned blocks, set this to 0. Even then, the store will never delete pinned blocks.
cache_size_bytes: u64
The target store size.
Up to this size, the store will retain everything even if not pinned. Once this size is exceeded, the store will run garbage collection of all unpinned blocks until the size criterion is met again.
The store will never delete pinned blocks.
gc_interval: Duration
The interval at which the garbage collector is run.
Note that this is implemented as delays between gcs, so it will not run exactly at this interval, but there will be some drift if gc takes long.
gc_min_blocks: usize
The minimum number of blocks to collect in any case.
Using this parameter, it is possible to guarantee a minimum rate with
which the gc will be able to keep up. It is gc_min_blocks
/
gc_interval
.
gc_target_duration: Duration
The target maximum gc duration of a single garbage collector run.
This can not be guaranteed, since we guarantee to collect at least
gc_min_blocks
. But as soon as this duration is exceeded, the
incremental gc will stop doing additional work.
Implementations
Trait Implementations
sourceimpl Clone for StorageConfig
impl Clone for StorageConfig
sourcefn clone(&self) -> StorageConfig
fn clone(&self) -> StorageConfig
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StorageConfig
impl Debug for StorageConfig
sourceimpl PartialEq<StorageConfig> for StorageConfig
impl PartialEq<StorageConfig> for StorageConfig
sourcefn eq(&self, other: &StorageConfig) -> bool
fn eq(&self, other: &StorageConfig) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StorageConfig) -> bool
fn ne(&self, other: &StorageConfig) -> bool
This method tests for !=
.
impl Eq for StorageConfig
impl StructuralEq for StorageConfig
impl StructuralPartialEq for StorageConfig
Auto Trait Implementations
impl RefUnwindSafe for StorageConfig
impl Send for StorageConfig
impl Sync for StorageConfig
impl Unpin for StorageConfig
impl UnwindSafe for StorageConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more