Struct gridly::prelude::Column

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

A column component of a Location. See Component for details.

Trait Implementations

impl Add<Column> for Row

Adding a component to its converse (ie, a Row to a Column) produces a Location

type Output = Location

The resulting type after applying the + operator.

#[must_use] fn add(self, rhs: Column) -> Location

Performs the + operation.

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<Row> for Column

Adding a component to its converse (ie, a Row to a Column) produces a Location

type Output = Location

The resulting type after applying the + operator.

#[must_use] fn add(self, rhs: Row) -> Location

Performs the + operation.

impl AddAssign<Columns> for Column

fn add_assign(&mut self, rhs: Columns)

Performs the += operation.

impl Clone for Column

fn clone(&self) -> Column

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Column

type Converse = Row

The converse component (Row to Column, or vice versa)

type Distance = Columns

The associated vector component (Rows or Columns)

fn from_location<L: LocationLike>(location: L) -> Self

Get this component type from a Location.

fn combine(self, other: Row) -> Location

Combine this component with its converse to create a Location. Note that Row and Column can simply be added together with + to create a new Location; this method exists to assist with generic code.

fn name() -> &'static str

Return the lowercase name of this component type– "row" or "column". Intended for debug printing, error messages, etc.

fn add_distance(self, distance: impl Into<Columns>) -> Self

Add a distance to this component. This method is provided because we can't require a trait bound on Add for Component, but in general just using + is preferable.

fn distance_from(self, origin: Self) -> Columns

Find the distance between two components, using the other component as the origin

fn value(self) -> isize

Get the integer value of this component

#[must_use] fn distance_to(self, target: Self) -> Self::Distance

Find the distance between two components, using this component as the origin

#[must_use] fn transpose(self) -> Self::Converse

Convert a Row into a Column or vice versa

Important traits for ComponentRange<C>

impl<C: Component> Iterator for ComponentRange<C> type Item = C;

#[must_use] fn span(self, length: Self::Distance) -> ComponentRange<Self>

Create a range, starting at this component, with the given length

Important traits for ComponentRange<C>

impl<C: Component> Iterator for ComponentRange<C> type Item = C;

#[must_use] fn range_to(self, end: Self) -> ComponentRange<Self>

Create a range, starting at this component, ending at the given component

impl Copy for Column

impl Debug for Column

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

Formats the value using the given formatter.

impl Default for Column

fn default() -> Column

Returns the "default value" for a type.

impl Eq for Column

impl From<isize> for Column

#[must_use] fn from(value: isize) -> Self

Performs the conversion.

impl Hash for Column

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 Ord for Column

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

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

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

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

This method tests for !=.

impl PartialOrd<Column> for Column

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Column

impl StructuralPartialEq for Column

impl Sub<Column> for Column

The difference between two location components is the distance between them

type Output = Columns

The resulting type after applying the - operator.

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

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

fn sub_assign(&mut self, rhs: Columns)

Performs the -= operation.