Struct ConfigFile 

pub struct ConfigFile {

    pub version: u32,
    pub id: RepositoryId,
    pub chunker: Option<Chunker>,
    pub chunker_polynomial: String,
    pub chunk_size: Option<usize>,
    pub chunk_min_size: Option<usize>,
    pub chunk_max_size: Option<usize>,
    pub is_hot: Option<bool>,
    pub append_only: Option<bool>,
    pub compression: Option<i32>,
    pub treepack_size: Option<u32>,
    pub treepack_growfactor: Option<u32>,
    pub treepack_size_limit: Option<u32>,
    pub datapack_size: Option<u32>,
    pub datapack_growfactor: Option<u32>,
    pub datapack_size_limit: Option<u32>,
    pub min_packsize_tolerate_percent: Option<u32>,
    pub max_packsize_tolerate_percent: Option<u32>,
    pub extra_verify: Option<bool>,
}

The config file describes all repository-wide information.

It is usually saved in the repository as config

Fields

version: u32

Repository version. Currently 1 and 2 are supported

id: RepositoryId

The [Id] identifying the repository

chunker: Option<Chunker>

The chunker polynomial used to chunk data

chunker_polynomial: String

The chunker polynomial used to chunk data in case of Rabin content defined chunking

chunk_size: Option<usize>

The (average) chunk size. For FixedSized chunking, this is the chunk size, for Rabin chunking, this size will be reached on average for chunks.

chunk_min_size: Option<usize>

The minimum chunk size. For Rabin chunking, this defines the minimum chunk size before chunks are defined by the Rabin fingerprint. Has no effect for FixedSized chunking.

chunk_max_size: Option<usize>

The maximum chunk size. For Rabin chunking, this defines the maximum chunk size, i.e. the size when chunks are cut even if no cut point has been identified by the Rabin fingerprint. Has no effect for FixedSized chunking.

is_hot: Option<bool>

Marker if this is a hot repository. If not set, this is no hot repository

Note

When using hot/cold repositories, this is only set within the hot part of the repository.

append_only: Option<bool>

Marker if this is a append-only repository.

Note

Commands which are not append-only won’t run once this is set.

compression: Option<i32>

Compression level

Note

Some(0) means no compression. If not set, use the default compression:

• for repository version 1, use no compression (as not supported)
• for repository version 2, use the zstd default compression

treepack_size: Option<u32>

Size of tree packs. This will be enhanced by the treepack_growfactor depending on the repository size

If not set, defaults to 4 MiB

treepack_growfactor: Option<u32>

Grow factor to increase size of tree packs depending on the repository size

If not set, defaults to 32

treepack_size_limit: Option<u32>

Maximum targeted tree pack size.

datapack_size: Option<u32>

Size of data packs. This will be enhanced by the datapack_growfactor depending on the repository size

If not set, defaults to 32 MiB

datapack_growfactor: Option<u32>

Grow factor to increase size of data packs depending on the repository size

If not set, defaults to 32

datapack_size_limit: Option<u32>

maximum targeted data pack size.

min_packsize_tolerate_percent: Option<u32>

Tolerate pack sizes which are larger than given percentage of targeted pack size

If not set, defaults to 30

max_packsize_tolerate_percent: Option<u32>

Tolerate pack sizes which are smaller than given percentage of targeted pack size

If not set or set to 0 this is unlimited.

extra_verify: Option<bool>

Do an extra verification by decompressing/decrypting all data before uploading to the repository

Implementations

impl ConfigFile

pub fn new(version: u32, id: RepositoryId, poly: u64) -> Self

Creates a new ConfigFile.

Arguments

• version - The version of the repository
• id - The id of the repository
• poly - The chunker polynomial

pub fn poly(&self) -> RusticResult<u64>

Get the chunker polynomial

Errors

• If the polynomial could not be parsed

pub fn zstd(&self) -> RusticResult<Option<i32>>

Get the compression level

Errors

• If the version is not supported

pub fn extra_verify(&self) -> bool

Get whether an extra verification (decompressing/decrypting data before writing to the repository) should be performed.

pub fn packsize(&self, blob: BlobType) -> (u32, u32, u32)

Get pack size parameter

Arguments

• blob - The blob type to get the pack size parameters for

Returns

A tuple containing the pack size, the grow factor and the size limit

pub fn packsize_ok_percents(&self) -> (u32, u32)

Get pack size toleration limits

Returns

pub fn chunker(&self) -> Chunker

Get the chunker

pub fn chunk_size(&self) -> usize

Get the (average) chunk size

pub fn chunk_min_size(&self) -> usize

Get the min chunk size

pub fn chunk_max_size(&self) -> usize

Get the max chunk size

pub fn has_same_chunker(&self, other: &Self) -> bool

Determine if two ConfigFiles have compatible chunker parameters

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl Default for ConfigFile

fn default() -> ConfigFile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigFile

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RepoFile for ConfigFile

const TYPE: FileType = FileType::Config

The FileType associated with the repository file

type Id = ConfigId

The Id type associated with the repository file

const ENCRYPTED: bool = true

Indicate whether the files are stored encrypted

impl Serialize for ConfigFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConfigFile

impl StructuralPartialEq for ConfigFile