Trait PosT 

pub trait PosT:
    Debug
    + Default
    + Eq
    + PartialOrd
    + Copy {
    type Xtype: BoundedInt;
    type Ytype: BoundedInt;

    const WIDTH: usize;
    const HEIGHT: usize;

    // Required method
    fn new_(xy: (Self::Xtype, Self::Ytype)) -> Self;

    // Provided methods
    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 { ... }
    fn into_tuple(self) -> (Self::Xtype, Self::Ytype)
       where Self: Sized { ... }
    fn tuple(&self) -> (Self::Xtype, Self::Ytype) { ... }
    fn x(&self) -> Self::Xtype { ... }
    fn y(&self) -> Self::Ytype { ... }
    fn inner_tuple(
        self,
    ) -> (<Self::Xtype as BoundedInt>::Inner, <Self::Ytype as BoundedInt>::Inner) { ... }
    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 { ... }
    fn width() -> usize { ... }
    fn height() -> usize { ... }
    fn dimensions() -> usize { ... }
    fn first() -> Self
       where Self: Sized { ... }
    fn last() -> Self
       where Self: Sized { ... }
    fn is_corner(&self) -> bool { ... }
    fn is_side(&self) -> bool { ... }
    fn flip_h(&self) -> Self
       where Self: Sized { ... }
    fn flip_v(&self) -> Self
       where Self: Sized { ... }
    fn manhattan(&self, pos: &Self) -> usize { ... }
    fn inside(&self, pos1: &Self, pos2: &Self) -> bool { ... }
    fn to_usize(&self) -> usize { ... }
    fn tryfrom_usize(i: usize) -> Result<Self, Error>
       where Self: Sized { ... }
    fn next(&self) -> Option<Self>
       where Self: Sized { ... }
    fn next_y(&self) -> Option<Self>
       where Self: Sized { ... }
    fn prev(&self) -> Option<Self>
       where Self: Sized { ... }
    fn prev_y(&self) -> Option<Self>
       where Self: Sized { ... }
    fn iter_x() -> impl Iterator<Item = Self::Xtype> { ... }
    fn iter_y() -> impl Iterator<Item = Self::Ytype> { ... }
    fn iter_orientation<const XFIRST: bool>() -> PosTIter<XFIRST, Self> 
       where Self: Sized { ... }
    fn iter() -> PosTIter<true, Self> 
       where Self: Sized { ... }
    fn iter_horizontal() -> PosTIter<true, Self> 
       where Self: Sized { ... }
    fn iter_vertical() -> PosTIter<false, Self> 
       where Self: Sized { ... }
    fn iter_range(topleft: Self, botright: Self) -> PosTIterRange<Self> 
       where Self: Sized + Copy { ... }
    fn iter_in_x(x: Self::Xtype) -> PosTIterInX<Self> 
       where Self: Sized { ... }
    fn iter_in_y(y: Self::Ytype) -> PosTIterInY<Self> 
       where Self: Sized { ... }
    fn tlbr_of(iter: impl Iterator<Item = Self>) -> Result<(Self, Self), Error>
       where Self: Sized { ... }
    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> { ... }
    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> { ... }
}

Position trait

Required Associated Constants

const WIDTH: usize

Width

const HEIGHT: usize

Height

Required Associated Types

type Xtype: BoundedInt

The type of the X coordinate

type Ytype: BoundedInt

The type of the Y coordinate

Required Methods

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

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

Provided Methods

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 into_tuple(self) -> (Self::Xtype, Self::Ytype)

where Self: Sized,

Return the corresponding tuple

Defining this can lead to less copies.

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

Return the corresponding tuple

You can either define both PosT::x and PosT::y, or PosT::tuple.

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

Get the X component

You can either define both PosT::x and PosT::y, or PosT::tuple.

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

Get the Y component

You can either define both PosT::x and PosT::y, or PosT::tuple.

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

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl PosT for (i8, i8)

const WIDTH: usize = 255usize

const HEIGHT: usize = 255usize

type Xtype = i8

type Ytype = i8

fn new_(xy: (i8, i8)) -> Self

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

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

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

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

impl PosT for (i16, i16)

const WIDTH: usize = 65_535usize

const HEIGHT: usize = 65_535usize

type Xtype = i16

type Ytype = i16

fn new_(xy: (i16, i16)) -> Self

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

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

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

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

impl PosT for (i32, i32)

const WIDTH: usize = 4_294_967_295usize

const HEIGHT: usize = 4_294_967_295usize

type Xtype = i32

type Ytype = i32

fn new_(xy: (i32, i32)) -> Self

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

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

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

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

impl PosT for (u8, u8)

const WIDTH: usize = 255usize

const HEIGHT: usize = 255usize

type Xtype = u8

type Ytype = u8

fn new_(xy: (u8, u8)) -> Self

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

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

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

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

impl PosT for (u16, u16)

const WIDTH: usize = 65_535usize

const HEIGHT: usize = 65_535usize

type Xtype = u16

type Ytype = u16

fn new_(xy: (u16, u16)) -> Self

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

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

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

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

impl PosT for (u32, u32)

const WIDTH: usize = 4_294_967_295usize

const HEIGHT: usize = 4_294_967_295usize

type Xtype = u32

type Ytype = u32

fn new_(xy: (u32, u32)) -> Self

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

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

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

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

impl PosT for (u64, u64)

const WIDTH: usize = 18_446_744_073_709_551_615usize

const HEIGHT: usize = 18_446_744_073_709_551_615usize

type Xtype = u64

type Ytype = u64

fn new_(xy: (u64, u64)) -> Self

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

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

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

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

impl PosT for (u128, u128)

const WIDTH: usize = 18_446_744_073_709_551_615usize

const HEIGHT: usize = 18_446_744_073_709_551_615usize

type Xtype = u128

type Ytype = u128

fn new_(xy: (u128, u128)) -> Self

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

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

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

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

Implementors

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

const WIDTH: usize

const HEIGHT: usize

type Xtype = BoundedU16<0, XMAX>

type Ytype = BoundedU16<0, YMAX>