Struct FeatureIndex 

pub struct FeatureIndex<const MAX_FEATURES: usize> { /* private fields */ }

Type-safe feature index with compile-time bounds checking

Implementations

impl<const MAX_FEATURES: usize> FeatureIndex<MAX_FEATURES>

pub const fn new(index: usize) -> Option<Self>

Create a new feature index with compile-time bounds checking

pub const unsafe fn new_unchecked(index: usize) -> Self

Create a new feature index without bounds checking (unsafe)

Safety

The caller must ensure that index < MAX_FEATURES

pub const fn get(self) -> usize

Get the inner index value

pub const fn to_runtime(self) -> RuntimeFeatureIndex

Convert to a runtime feature index

Trait Implementations

impl<const MAX_FEATURES: usize> Clone for FeatureIndex<MAX_FEATURES>

fn clone(&self) -> FeatureIndex<MAX_FEATURES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX_FEATURES: usize> Debug for FeatureIndex<MAX_FEATURES>

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

Formats the value using the given formatter.

impl<const MAX_FEATURES: usize> Ord for FeatureIndex<MAX_FEATURES>

fn cmp(&self, other: &FeatureIndex<MAX_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<const MAX_FEATURES: usize> PartialEq for FeatureIndex<MAX_FEATURES>

fn eq(&self, other: &FeatureIndex<MAX_FEATURES>) -> 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<const MAX_FEATURES: usize> PartialOrd for FeatureIndex<MAX_FEATURES>

fn partial_cmp(&self, other: &FeatureIndex<MAX_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<const N: usize> ZeroCostTransform<FeatureIndex<N>, usize> for ()

Zero-cost feature index conversion

fn transform_zero_cost(input: FeatureIndex<N>) -> usize

Apply the transformation with zero runtime cost

impl<const MAX_FEATURES: usize> Copy for FeatureIndex<MAX_FEATURES>

impl<const MAX_FEATURES: usize> Eq for FeatureIndex<MAX_FEATURES>

impl<const MAX_FEATURES: usize> StructuralPartialEq for FeatureIndex<MAX_FEATURES>