Enum stdbench::Stage

pub enum Stage {
    Compile,
    BuildIndex,
    ParseCollection,
    ParseBatches,
    Invert,
}

Available stages of the experiment.

Examples

All names are lowercase:

assert_eq!("compile".parse(), Ok(Stage::Compile));
assert_eq!("build".parse(), Ok(Stage::BuildIndex));
assert_eq!("parse".parse(), Ok(Stage::ParseCollection));
assert_eq!("invert".parse(), Ok(Stage::Invert));
assert!("?".parse::<Stage>().is_err());
assert_eq!("compile", format!("{}", Stage::Compile));
assert_eq!("build", format!("{}", Stage::BuildIndex));
assert_eq!("parse", format!("{}", Stage::ParseCollection));
assert_eq!("invert", format!("{}", Stage::Invert));

Variants

Compile

Compilation stage; includes things such as: fetching code, configuring, and actual compilation of the source code. The exact meaning depends on the type of the source being processed.

BuildIndex

Includes building forward/inverted index and index compressing.

ParseCollection

A subset of BuildIndex; means: build an inverted index but assume the forward index has been already built (e.g., in a previous run).

ParseBatches

A subset of ParseCollection; means: use parse_collection with merge subcommand to only merge previously produced batch files.

Invert

Inverting stage; mean: compress an inverted index but do not invert forward index, assuming it has been done already.

Trait Implementations

impl Eq for Stage

impl PartialEq<Stage> for Stage

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

impl Clone for Stage

fn clone(&self) -> Stage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for Stage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Display for Stage

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

Formats the value using the given formatter.

impl Debug for Stage

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

Formats the value using the given formatter.

impl FromStr for Stage

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Stage, Self::Err>

Parses a string s to return a value of this type.

impl IntoEnumIterator for Stage

type Iterator = StageIter

Important traits for StageIter

impl Iterator for StageIter type Item = Stage;

fn iter() -> StageIter