Struct RowIndex

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

A newtype wrapper around a usize value representing a step in the execution trace.

Implementations

impl RowIndex

pub fn as_usize(&self) -> usize

pub fn as_u32(&self) -> u32

impl RowIndex

pub fn saturating_sub(self, rhs: u32) -> RowIndex

pub fn max(self, other: RowIndex) -> RowIndex

Trait Implementations

impl Add<usize> for RowIndex

Adds a usize to a RowIndex.

Panics

This function will panic if the number represented by the usize is greater than the maximum RowIndex value, u32::MAX.

type Output = RowIndex

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> <RowIndex as Add<usize>>::Output

Performs the + operation.

impl AddAssign<u32> for RowIndex

Adds a u32 value to a RowIndex in place.

Panics

This function will panic if the internal value of the RowIndex would exceed the maximum value u32::MAX.

fn add_assign(&mut self, rhs: u32)

Performs the += operation.

impl AddAssign<usize> for RowIndex

Adds a usize value to a RowIndex in place.

Panics

This function will panic if the internal value of the RowIndex would exceed the maximum value u32::MAX.

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for RowIndex

fn clone(&self) -> RowIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RowIndex

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

Formats the value using the given formatter.

impl Display for RowIndex

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

Formats the value using the given formatter.

impl From<RowIndex> for ContextId

fn from(value: RowIndex) -> Self

Converts to this type from the input type.

impl From<RowIndex> for BaseElement

fn from(step: RowIndex) -> BaseElement

Converts to this type from the input type.

impl From<i32> for RowIndex

Converts an i32 value into a RowIndex.

Panics

This function will panic if the number represented by the i32 is less than 0.

fn from(value: i32) -> RowIndex

Converts to this type from the input type.

impl From<u32> for RowIndex

fn from(value: u32) -> RowIndex

Converts to this type from the input type.

impl From<usize> for RowIndex

Converts a usize value into a RowIndex.

Panics

This function will panic if the number represented by the usize is greater than the maximum RowIndex value, u32::MAX.

fn from(value: usize) -> RowIndex

Converts to this type from the input type.

impl<T> Index<RowIndex> for [T]

type Output = T

The returned type after indexing.

fn index(&self, i: RowIndex) -> &<[T] as Index<RowIndex>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<RowIndex> for [T]

fn index_mut(&mut self, i: RowIndex) -> &mut <[T] as Index<RowIndex>>::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for RowIndex

fn cmp(&self, other: &RowIndex) -> 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<usize> for RowIndex

fn eq(&self, rhs: &usize) -> 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 PartialEq for RowIndex

fn eq(&self, rhs: &RowIndex) -> 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 PartialOrd<usize> for RowIndex

fn partial_cmp(&self, rhs: &usize) -> 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 PartialOrd for RowIndex

fn partial_cmp(&self, other: &RowIndex) -> 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 RangeBounds<RowIndex> for RowIndex

fn start_bound(&self) -> Bound<&RowIndex>

Start index bound.

fn end_bound(&self) -> Bound<&RowIndex>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

impl Sub<usize> for RowIndex

Subtracts a usize from a RowIndex.

Panics

This function will panic if the number represented by the usize is greater than the maximum RowIndex value, u32::MAX.

type Output = RowIndex

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> <RowIndex as Sub<usize>>::Output

Performs the - operation.

impl Sub for RowIndex

type Output = usize

The resulting type after applying the - operator.

fn sub(self, rhs: RowIndex) -> <RowIndex as Sub>::Output

Performs the - operation.

impl SubAssign<u32> for RowIndex

fn sub_assign(&mut self, rhs: u32)

Performs the -= operation.

impl TryFrom<u64> for RowIndex

Converts a u64 value into a RowIndex.

Errors

This function returns an error if the number represented by the u64 is greater than the maximum RowIndex value, u32::MAX.

type Error = RowIndexError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<RowIndex, <RowIndex as TryFrom<u64>>::Error>

Performs the conversion.

impl Copy for RowIndex

impl Eq for RowIndex