Struct IndexConfig

pub struct IndexConfig {
    pub aux_path: String,
    pub staging_size: ReadableSize,
    pub staging_ttl: Option<Duration>,
    pub write_buffer_size: ReadableSize,
    pub metadata_cache_size: ReadableSize,
    pub content_cache_size: ReadableSize,
    pub content_cache_page_size: ReadableSize,
}

Fields

aux_path: String

Auxiliary directory path for the index in filesystem, used to store intermediate files for creating the index and staging files for searching the index, defaults to {data_home}/index_intermediate.

This path contains two subdirectories:

• __intm: for storing intermediate files used during creating index.
• staging: for storing staging files used during searching index.

The default name for this directory is index_intermediate for backward compatibility.

staging_size: ReadableSize

The max capacity of the staging directory.

staging_ttl: Option<Duration>

The TTL of the staging directory. Defaults to 7 days. Setting it to “0s” to disable TTL.

write_buffer_size: ReadableSize

Write buffer size for creating the index.

metadata_cache_size: ReadableSize

Cache size for metadata of puffin files. Setting it to 0 to disable the cache.

content_cache_size: ReadableSize

Cache size for inverted index content. Setting it to 0 to disable the cache.

content_cache_page_size: ReadableSize

Page size for inverted index content.

Implementations

impl IndexConfig

pub fn sanitize( &mut self, data_home: &str, inverted_index: &InvertedIndexConfig, ) -> Result<()>

Trait Implementations

impl Clone for IndexConfig

fn clone(&self) -> IndexConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexConfig

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

Formats the value using the given formatter.

impl Default for IndexConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexConfig

where IndexConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IndexConfig

fn eq(&self, other: &IndexConfig) -> 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 Serialize for IndexConfig

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 IndexConfig

impl StructuralPartialEq for IndexConfig