Struct KxDatabaseCacheConfiguration

#[non_exhaustive]
pub struct KxDatabaseCacheConfiguration {
    pub cache_type: String,
    pub db_paths: Vec<String>,
    pub dataview_name: Option<String>,
}

The structure of database cache configuration that is used for mapping database paths to cache types in clusters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cache_type: String

The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

• CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

db_paths: Vec<String>

Specifies the portions of database that will be loaded into the cache for access.

dataview_name: Option<String>

The name of the dataview to be used for caching historical data on disk.

Implementations

impl KxDatabaseCacheConfiguration

pub fn cache_type(&self) -> &str

The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

• CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

pub fn db_paths(&self) -> &[String]

Specifies the portions of database that will be loaded into the cache for access.

pub fn dataview_name(&self) -> Option<&str>

The name of the dataview to be used for caching historical data on disk.

impl KxDatabaseCacheConfiguration

pub fn builder() -> KxDatabaseCacheConfigurationBuilder

Creates a new builder-style object to manufacture KxDatabaseCacheConfiguration.

Trait Implementations

impl Clone for KxDatabaseCacheConfiguration

fn clone(&self) -> KxDatabaseCacheConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KxDatabaseCacheConfiguration

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

Formats the value using the given formatter.

impl PartialEq for KxDatabaseCacheConfiguration

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