Struct ipfs_embed::StorageConfig

pub struct StorageConfig {
    pub 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,
}

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.

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

impl StorageConfig

pub fn new(
    path: Option<PathBuf>,
    cache_size: u64,
    gc_interval: Duration
) -> Self

Creates a new StorageConfig.

Trait Implementations

impl Clone for StorageConfig

fn clone(&self) -> StorageConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageConfig

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

Formats the value using the given formatter.

impl PartialEq<StorageConfig> for StorageConfig

fn eq(&self, other: &StorageConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StorageConfig) -> bool

This method tests for !=.

impl Eq for StorageConfig

impl StructuralEq for StorageConfig

impl StructuralPartialEq for StorageConfig