Struct stdbench::config::Collection

pub struct Collection {
    pub name: String,
    pub kind: Box<dyn CollectionType>,
    pub collection_dir: PathBuf,
    pub forward_index: PathBuf,
    pub inverted_index: PathBuf,
    pub encodings: Vec<Encoding>,
}

Configuration of a tested collection.

Fields

name: String

A collection name.

kind: Box<dyn CollectionType>

The colleciton's type used when deciding on how to parse it.

collection_dir: PathBuf

The root directory of the collection. Depending on a type, it could contain one or many files or directories. Must use name to determine how to find relevant data.

forward_index: PathBuf

The basename of the forward index.

inverted_index: PathBuf

The basename of the inverted index.

encodings: Vec<Encoding>

The list of index encoding techniques to be tested. The compression step will be therefore run encodings.len() times, one for each technique.

Methods

impl Collection

pub fn fwd(&self) -> Result<&str, Error>

Returns a string representing forward index path.

pub fn inv(&self) -> Result<&str, Error>

Returns a string representing inverted index path.

Trait Implementations

impl FromYaml for Collection

fn from_yaml(yaml: &Yaml) -> Result<Self, Error>

Parse YAML to Self.

fn from_yaml_at_key(yaml: &Yaml, key: &str) -> Result<Self, Error>

Parse a property value at a given key.

impl PartialEq<Collection> for Collection

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Collection

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

Formats the value using the given formatter.