Struct Pos 

pub struct Pos<const XMAX: u16, const YMAX: u16>(pub (BoundedU16<0, XMAX>, BoundedU16<0, YMAX>));

Square grid absolute coordinate

This generic type receives the dimensions of the square grid as const generic parameters, and prevents the cration of instances outside the grid.

Recommended usage is through a type alias; for instance, to create a 4x4 grid coordinate type:

type Pos = sqrid::Pos<4, 4>;

We can only generate Pos instances that are valid - i.e. inside the grid. Some of the ways to create instances:

• Using one of the const associated items: Pos::FIRST and Pos::LAST; Pos::TOP_LEFT, etc.; Pos::CENTER.
• Using Pos::new with X and Y coordinates and handling the Result; can also be used in const contexts.

  let pos = Pos::new(3, 3)?;

• Using try_from with a (u16, u16) tuple or a tuple reference. It’s equivalent to Pos::new:

  use std::convert::{TryFrom, TryInto};
  let pos1 = Pos::try_from((3, 3))?;
  let pos2 : Pos = (3_u16, 3_u16).try_into()?;

• Using Pos::new_unwrap, be be aware that it panics if the coordinates are not valid. This is convenient in const contexts, as unwrap is not a const fn method.

  const pos : Pos = Pos::new_unwrap(3, 3);

• Using Pos::new_static to create an instance at compile time, which is also when the validity of the coordinates is checked.

  const POS : Pos = Pos::new_static::<3, 3>();

  The following, for instance, doesn’t compile:

  const POS : Pos = Pos::new_static::<3, 30>();

Tuple Fields

0: (BoundedU16<0, XMAX>, BoundedU16<0, YMAX>)

Implementations

impl<const XMAX: u16, const YMAX: u16> Pos<XMAX, YMAX>

pub const XMAX: u16 = XMAX

Max x value

pub const YMAX: u16 = YMAX

Max y value

pub const WIDTH: u16

Width of the grid: exclusive max of the x coordinate.

pub const HEIGHT: u16

Height of the grid: exclusive max of the y coordinate.

pub const SIZE: usize

Size of the grid, i.e. how many squares.

pub const FIRST: Pos<XMAX, YMAX>

Coordinates of the first element of the grid: (0, 0). Also known as origin.

pub const LAST: Pos<XMAX, YMAX>

Coordinates of the last element of the grid.

pub const CENTER: Pos<XMAX, YMAX>

Center the (approximate) center coordinate.

pub const TOP_LEFT: Pos<XMAX, YMAX> = Self::FIRST

Coordinates of the top-left coordinate.

pub const TOP_RIGHT: Pos<XMAX, YMAX>

Coordinates of the top-right coordinate.

pub const BOTTOM_LEFT: Pos<XMAX, YMAX>

Coordinates of the bottom-left coordinate.

pub const BOTTOM_RIGHT: Pos<XMAX, YMAX> = Self::LAST

Coordinates of the bottom-right coordinate.

pub const fn new(x: u16, y: u16) -> Result<Self, Error>

Create a new Pos instance; returns error if a coordinate is out-of-bounds.

pub const fn new_unwrap(x: u16, y: u16) -> Self

Create a new Pos instance, supports being called in const context; panics if a coordinate is out-of-bounds.

pub const fn new_static<const X: u16, const Y: u16>() -> Self

Create a new Pos instance at compile time.

Checks arguments at compile time - for instance, the following doesn’t compile:

const POS : sqrid::Pos<5,5> = sqrid::Pos::<5,5>::new_static::<9,9>();

pub const fn x(&self) -> u16

Returns the x coordinate

pub const fn y(&self) -> u16

Returns the y coordinate

pub const fn tuple(&self) -> (u16, u16)

Return the corresponding (u16, u16) tuple.

Trait Implementations

impl<const XMAX: u16, const YMAX: u16> Add<Dir> for &Pos<XMAX, YMAX>

where (BoundedU16<0, XMAX>, BoundedU16<0, YMAX>): Add<Dir, Output = Result<(BoundedU16<0, XMAX>, BoundedU16<0, YMAX>), Error>>,

type Output = Result<Pos<XMAX, YMAX>, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Dir) -> Self::Output

Performs the + operation.

impl<const XMAX: u16, const YMAX: u16> Add<Dir> for Pos<XMAX, YMAX>

where (BoundedU16<0, XMAX>, BoundedU16<0, YMAX>): Add<Dir, Output = Result<(BoundedU16<0, XMAX>, BoundedU16<0, YMAX>), Error>>,

type Output = Result<Pos<XMAX, YMAX>, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Dir) -> Self::Output

Performs the + operation.

impl<const XMAX: u16, const YMAX: u16> Clone for Pos<XMAX, YMAX>

fn clone(&self) -> Pos<XMAX, YMAX>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const XMAX: u16, const YMAX: u16> Debug for Pos<XMAX, YMAX>

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

Formats the value using the given formatter.

impl<const XMAX: u16, const YMAX: u16> Default for Pos<XMAX, YMAX>

fn default() -> Pos<XMAX, YMAX>

Returns the “default value” for a type.

impl<const XMAX: u16, const YMAX: u16> Display for Pos<XMAX, YMAX>

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

Formats the value using the given formatter.

impl<const XMAX: u16, const YMAX: u16> From<&(BoundedU16<0, XMAX>, BoundedU16<0, YMAX>)> for Pos<XMAX, YMAX>

fn from(xy: &(BoundedU16<0, XMAX>, BoundedU16<0, YMAX>)) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> From<&Pos<XMAX, YMAX>> for (i32, i32)

fn from(pos: &Pos<XMAX, YMAX>) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> From<&Pos<XMAX, YMAX>> for (u16, u16)

fn from(pos: &Pos<XMAX, YMAX>) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> From<&Pos<XMAX, YMAX>> for usize

fn from(pos: &Pos<XMAX, YMAX>) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> From<(BoundedU16<0, XMAX>, BoundedU16<0, YMAX>)> for Pos<XMAX, YMAX>

fn from(xy: (BoundedU16<0, XMAX>, BoundedU16<0, YMAX>)) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> From<Pos<XMAX, YMAX>> for (i32, i32)

fn from(pos: Pos<XMAX, YMAX>) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> From<Pos<XMAX, YMAX>> for (u16, u16)

fn from(pos: Pos<XMAX, YMAX>) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> From<Pos<XMAX, YMAX>> for usize

fn from(pos: Pos<XMAX, YMAX>) -> Self

Converts to this type from the input type.

impl<const XMAX: u16, const YMAX: u16> Hash for Pos<XMAX, YMAX>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const XMAX: u16, const YMAX: u16> Ord for Pos<XMAX, YMAX>

fn cmp(&self, other: &Pos<XMAX, YMAX>) -> 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 XMAX: u16, const YMAX: u16> PartialEq for Pos<XMAX, YMAX>

fn eq(&self, other: &Pos<XMAX, YMAX>) -> 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 XMAX: u16, const YMAX: u16> PartialOrd for Pos<XMAX, YMAX>

fn partial_cmp(&self, other: &Pos<XMAX, YMAX>) -> 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 XMAX: u16, const YMAX: u16> PosT for Pos<XMAX, YMAX>

const WIDTH: usize

Width

const HEIGHT: usize

Height

type Xtype = BoundedU16<0, XMAX>

The type of the X coordinate

type Ytype = BoundedU16<0, YMAX>

The type of the Y coordinate

fn new_(xy: (Self::Xtype, Self::Ytype)) -> Self

Internal new_ that creates the Pos type from the provided tuple.

fn into_tuple(self) -> (Self::Xtype, Self::Ytype)

Return the corresponding tuple

fn tuple(&self) -> (Self::Xtype, Self::Ytype)

Return the corresponding tuple

fn x(&self) -> Self::Xtype

Get the X component

fn y(&self) -> Self::Ytype

Get the Y component

fn new<X, Y>(x: X, y: Y) -> Result<Self, Error>

where X: BoundedInt, Y: BoundedInt, Self::Xtype: TryFrom<X>, Self::Ytype: TryFrom<Y>, Self: Sized,

Create a new Pos with the given parameters

fn inner_tuple( self, ) -> (<Self::Xtype as BoundedInt>::Inner, <Self::Ytype as BoundedInt>::Inner)

Return the corresponding inner tuple

fn tryfrom_pos<P>(pos: P) -> Result<Self, Error>

where P: PosT, Self::Xtype: TryFrom<<P::Xtype as BoundedInt>::Inner>, Self::Ytype: TryFrom<<P::Ytype as BoundedInt>::Inner>, <P::Xtype as BoundedInt>::Inner: BoundedInt, <P::Ytype as BoundedInt>::Inner: BoundedInt, Self: Sized,

Create a position from another position

fn width() -> usize

Return the width (x) supported by the position type

fn height() -> usize

Return the height (y) supported by the position type

fn dimensions() -> usize

Return the total dimension supported by the position type

fn first() -> Self

where Self: Sized,

First coordinate, top left, origin

fn last() -> Self

where Self: Sized,

Last coordinate, bottom right

fn is_corner(&self) -> bool

Return true if self is a corner of the grid.

fn is_side(&self) -> bool

Return true if self is on the side of the grid.

fn flip_h(&self) -> Self

where Self: Sized,

Flip the coordinate vertically

fn flip_v(&self) -> Self

where Self: Sized,

Flip the coordinate horizontally

fn manhattan(&self, pos: &Self) -> usize

Return the manhattan distance

fn inside(&self, pos1: &Self, pos2: &Self) -> bool

Check that the position is inside the provided limits

fn to_usize(&self) -> usize

Return a usize index corresponding to the position.

fn tryfrom_usize(i: usize) -> Result<Self, Error>

where Self: Sized,

Create a new position from the provided usize, if possible; return an error otherwise.

fn next(&self) -> Option<Self>

where Self: Sized,

Return the next position horizontally (English read sequence), or None if self is the last one.

fn next_y(&self) -> Option<Self>

where Self: Sized,

Return the next position vertically, or None if self is the last one.

fn prev(&self) -> Option<Self>

where Self: Sized,

Return the previous position horizontally (English read sequence), or None if self is the first one.

fn prev_y(&self) -> Option<Self>

where Self: Sized,

Return the previous position vertically, or None if self is the first one.

fn iter_x() -> impl Iterator<Item = Self::Xtype>

Returns an iterator over valid X values

fn iter_y() -> impl Iterator<Item = Self::Ytype>

Returns an iterator over valid Y values

fn iter_orientation<const XFIRST: bool>() -> PosTIter<XFIRST, Self>

where Self: Sized,

Return an iterator that returns all positions within the grid dimensions in the given orientation - true for horizontally, false for vertically.

fn iter() -> PosTIter<true, Self>

where Self: Sized,

Return an iterator that returns all positions within the grid dimensions.

fn iter_horizontal() -> PosTIter<true, Self>

where Self: Sized,

Return an iterator that returns all positions within the grid dimensions horizontally.

fn iter_vertical() -> PosTIter<false, Self>

where Self: Sized,

Return an iterator that returns all positions within the grid dimensions vertically.

fn iter_range(topleft: Self, botright: Self) -> PosTIterRange<Self>

where Self: Sized + Copy,

Return an iterator that returns all positions within the grid coordinates.

fn iter_in_x(x: Self::Xtype) -> PosTIterInX<Self>

where Self: Sized,

Return an iterator that returns all positions in a column.

fn iter_in_y(y: Self::Ytype) -> PosTIterInY<Self>

where Self: Sized,

Return an iterator that returns all positions in a line.

fn tlbr_of(iter: impl Iterator<Item = Self>) -> Result<(Self, Self), Error>

where Self: Sized,

Calculate a top-left and a bottom-right Pos’s that contains all iterated points.

fn rotate_cw(&self) -> Self

where <<Self as PosT>::Ytype as BoundedInt>::Inner: Sub<Output = <<Self as PosT>::Ytype as BoundedInt>::Inner>, Self::Xtype: TryFrom<<<Self as PosT>::Ytype as BoundedInt>::Inner>, Self::Ytype: TryFrom<<<Self as PosT>::Xtype as BoundedInt>::Inner>,

Rotate the square grid coordinate 90 degrees clockwise

fn rotate_cc(&self) -> Self

where <<Self as PosT>::Xtype as BoundedInt>::Inner: Sub<Output = <<Self as PosT>::Xtype as BoundedInt>::Inner>, Self::Xtype: TryFrom<<<Self as PosT>::Ytype as BoundedInt>::Inner>, Self::Ytype: TryFrom<<<Self as PosT>::Xtype as BoundedInt>::Inner>,

Rotate the square grid coordinate 90 degrees counter-clockwise

impl<const XMAX: u16, const YMAX: u16> TryFrom<&(i32, i32)> for Pos<XMAX, YMAX>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(i32, i32)) -> Result<Self, Self::Error>

Performs the conversion.

impl<const XMAX: u16, const YMAX: u16> TryFrom<&(u16, u16)> for Pos<XMAX, YMAX>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: &(u16, u16)) -> Result<Self, Self::Error>

Performs the conversion.

impl<const XMAX: u16, const YMAX: u16> TryFrom<(i32, i32)> for Pos<XMAX, YMAX>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: (i32, i32)) -> Result<Self, Self::Error>

Performs the conversion.

impl<const XMAX: u16, const YMAX: u16> TryFrom<(u16, u16)> for Pos<XMAX, YMAX>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xy: (u16, u16)) -> Result<Self, Self::Error>

Performs the conversion.

impl<const XMAX: u16, const YMAX: u16> TryFrom<usize> for Pos<XMAX, YMAX>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(i: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl<const XMAX: u16, const YMAX: u16> Copy for Pos<XMAX, YMAX>

impl<const XMAX: u16, const YMAX: u16> Eq for Pos<XMAX, YMAX>

impl<const XMAX: u16, const YMAX: u16> StructuralPartialEq for Pos<XMAX, YMAX>