Struct Features 

pub struct Features(/* private fields */);

A simple list of features for annotating gated benchmarks/inputs.

Features supports one of the following four patterns:

A singular feature:

use diskann_benchmark_runner::Features;

let features = Features::new("a");
assert_eq!(features.to_string(), "feature \"a\"");

A conjunction:

use diskann_benchmark_runner::Features;

let features = Features::all(["a", "b"]);
assert_eq!(features.to_string(), "features \"a\" and \"b\"");

A disjunction:

use diskann_benchmark_runner::Features;

let features = Features::any(["a", "b"]);
assert_eq!(features.to_string(), "features \"a\" or \"b\"");

A custom layout:

use diskann_benchmark_runner::Features;

let features = Features::custom("(\"a\" and \"b\") or \"c\"", true);
assert_eq!(features.to_string(), "features (\"a\" and \"b\") or \"c\"");

See: crate::Registry::register_gated and crate::Registry::register_partially_gated.

Implementations

impl Features

pub fn new(feature: &'static str) -> Self

Construct a singular Features.

pub fn any<I>(itr: I) -> Self

where I: IntoIterator<Item = &'static str>,

Construct a Features as a disjunction of features.

pub fn all<I>(itr: I) -> Self

where I: IntoIterator<Item = &'static str>,

Construct a Features as a conjunction of features.

pub fn custom(custom: &'static str, plural: bool) -> Self

Construct a Features with a custom formatted string where plural can be used to control whether the returned struct uses “feature” or “features” in its formatting.

Trait Implementations

impl Clone for Features

fn clone(&self) -> Features

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Features

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

Formats the value using the given formatter.

impl Display for Features

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

Formats the value using the given formatter.

impl Eq for Features

impl From<&'static str> for Features

fn from(feature: &'static str) -> Features

Converts to this type from the input type.

impl Ord for Features

fn cmp(&self, other: &Features) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Features

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Features

fn partial_cmp(&self, other: &Features) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Features