Struct unsegen::base::basic_types::AxisIndex

pub struct AxisIndex<T: AxisDimension> { /* fields omitted */ }

AxisIndex (the base for ColIndex or RowIndex) is a signed integer coordinate (i.e., a coordinate of a point on the terminal cell grid)

Implementations

impl<T: AxisDimension> AxisIndex<T>

pub fn new(v: i32) -> Self

Create a new AxisIndex from an i32. Any i32 value is valid.

pub fn raw_value(self) -> i32

Unpack the AxisDiff to receive the raw i32 value.

pub fn diff_to_origin(self) -> AxisDiff<T>

Calculate the origin of the Index to the origin of the coordinate grid (i.e., 0). Technically this just converts an AxisIndex into an AxisDiff, but is semantically more explicit.

Examples:

use unsegen::base::{ColIndex, ColDiff};
assert_eq!(ColIndex::new(27).diff_to_origin(), ColDiff::new(27));

pub fn positive_or_zero(self) -> AxisIndex<T>

Clamp the value into a positive or zero range

Examples:

use unsegen::base::ColIndex;
assert_eq!(ColIndex::new(27).positive_or_zero(), ColIndex::new(27));
assert_eq!(ColIndex::new(0).positive_or_zero(), ColIndex::new(0));
assert_eq!(ColIndex::new(-37).positive_or_zero(), ColIndex::new(0));

Trait Implementations

impl<T: AxisDimension, I: Into<AxisDiff<T>>> Add<I> for AxisIndex<T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: I) -> Self

Performs the + operation.

impl<T: AxisDimension, I: Into<AxisDiff<T>>> AddAssign<I> for AxisIndex<T>

fn add_assign(&mut self, rhs: I)

Performs the += operation.

impl<T: Clone + AxisDimension> Clone for AxisIndex<T>

fn clone(&self) -> AxisIndex<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + AxisDimension> Copy for AxisIndex<T>

impl<T: Debug + AxisDimension> Debug for AxisIndex<T>

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

Formats the value using the given formatter.

impl<T: Eq + AxisDimension> Eq for AxisIndex<T>

impl<T: AxisDimension> From<i32> for AxisIndex<T>

fn from(v: i32) -> Self

Performs the conversion.

impl<T: AxisDimension> Into<i32> for AxisIndex<T>

fn into(self) -> i32

Performs the conversion.

impl<T: AxisDimension> Into<isize> for AxisIndex<T>

fn into(self) -> isize

Performs the conversion.

impl<T: AxisDimension> Neg for AxisIndex<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Ord + AxisDimension> Ord for AxisIndex<T>

fn cmp(&self, other: &AxisIndex<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: AxisDimension, I: Into<AxisIndex<T>> + Copy> PartialEq<I> for AxisIndex<T>

fn eq(&self, other: &I) -> 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<T: AxisDimension, I: Into<AxisIndex<T>> + Copy> PartialOrd<I> for AxisIndex<T>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: AxisDimension, I: Into<AxisIndex<T>>> Rem<I> for AxisIndex<T>

type Output = Self

The resulting type after applying the % operator.

fn rem(self, modulus: I) -> Self

Performs the % operation.

impl<T: AxisDimension> StructuralEq for AxisIndex<T>

impl<T: AxisDimension> Sub<AxisIndex<T>> for AxisIndex<T>

type Output = AxisDiff<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<T: AxisDimension, I: Into<AxisDiff<T>>> Sub<I> for AxisIndex<T>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: I) -> Self

Performs the - operation.

impl<T: AxisDimension, I: Into<AxisDiff<T>>> SubAssign<I> for AxisIndex<T>

fn sub_assign(&mut self, rhs: I)

Performs the -= operation.