Struct gridly::prelude::Columns

#[repr(transparent)]
pub struct Columns(pub isize);

A columns component of a Vector

Trait Implementations

impl Component for Columns

type Converse = Rows

The converse component (Rows to Columns or vice versa)

type Point = Column

The assoicated location component type (Row or Column)

fn from_vector(vector: impl VectorLike) -> Self

Get this compnent from a Vector

fn combine(self, other: Rows) -> Vector

Create a vector from a Row and Column

fn value(self) -> isize

Get the integer value of this component.

fn transpose(self) -> Self::Converse

impl VectorLike for Columns

A Rows or a Columns value can be treated as a Vector where the converse component is 0.

fn columns(&self) -> Columns

fn rows(&self) -> Rows

fn as_vector(&self) -> Vector

fn manhattan_length(&self) -> isize

Return the manhattan length of the vector. The manhattan length of a vector is the sum of the absolute values of its components.

fn checked_manhattan_length(&self) -> Option<isize>

Return the manhatten length of the vector, or None if there are any overflows.

fn clockwise(&self) -> Vector

Return a new vector, rotated 90 degrees clockwise.

fn anticlockwise(&self) -> Vector

Return a new vector, rotated 90 degrees counterclockwise.

fn reverse(&self) -> Vector

fn get_component<T: Component>(&self) -> T

Generically get either the Rows or Columns of a vector

fn transpose(&self) -> Vector

Swap the rows and columns of this Vector

fn direction(&self) -> Option<Direction>

If the vector is pointing in an orthogonal direction, return that direction

impl Eq for Columns

impl Default for Columns

fn default() -> Columns

Returns the "default value" for a type.

impl Clone for Columns

fn clone(&self) -> Columns

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Columns> for Columns

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<isize> for Columns

fn partial_cmp(&self, rhs: &isize) -> Option<Ordering>

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

fn lt(&self, rhs: &isize) -> bool

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

fn le(&self, rhs: &isize) -> bool

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

fn ge(&self, rhs: &isize) -> bool

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

fn gt(&self, rhs: &isize) -> bool

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

impl PartialEq<Columns> for Columns

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<isize> for Columns

fn eq(&self, rhs: &isize) -> 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 Ord for Columns

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl From<isize> for Columns

fn from(value: isize) -> Self

Performs the conversion.

impl Copy for Columns

impl Hash for Columns

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 Add<Columns> for Column

type Output = Self

The resulting type after applying the + operator.

#[must_use] fn add(self, rhs: Columns) -> Self

Performs the + operation.

impl Add<Columns> for Rows

Adding a Rows to a Columns produces a Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, rhs: Columns) -> Vector

Performs the + operation.

impl Add<Rows> for Columns

Adding a Rows to a Columns produces a Vector

type Output = Vector

The resulting type after applying the + operator.

fn add(self, rhs: Rows) -> Vector

Performs the + operation.

impl<T: Into<Columns>> Add<T> for Columns

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<Columns> for Column

type Output = Self

The resulting type after applying the - operator.

#[must_use] fn sub(self, rhs: Columns) -> Self

Performs the - operation.

impl<T: Into<Columns>> Sub<T> for Columns

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Mul<T> for Columns where
    isize: Mul<T, Output = isize>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, factor: T) -> Self

Performs the * operation.

impl Neg for Columns

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl AddAssign<Columns> for Column

fn add_assign(&mut self, rhs: Columns)

Performs the += operation.

impl<T: Into<Columns>> AddAssign<T> for Columns

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl SubAssign<Columns> for Column

fn sub_assign(&mut self, rhs: Columns)

Performs the -= operation.

impl<T: Into<Columns>> SubAssign<T> for Columns

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T> MulAssign<T> for Columns where
    isize: MulAssign<T>, 

fn mul_assign(&mut self, factor: T)

Performs the *= operation.

impl Debug for Columns

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

Formats the value using the given formatter.

impl Sum<Columns> for Columns

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl<'a> Sum<&'a Columns> for Columns

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by "summing up" the items.