Trait Shape 

pub trait Shape: Clone {
    type Axis: Axis;
    type Coordinate: Coordinate;
    type OffsetConvertError: Debug + Clone;
    type CoordinateMoveError: Debug + Clone;

    // Required methods
    fn horizontal(&self) -> usize;
    fn vertical(&self) -> usize;
    fn to_offset(
        &self,
        coord: Self::Coordinate,
    ) -> Result<Offset, Self::OffsetConvertError>;
    fn offset_to_coordinate(&self, offset: Offset) -> Self::Coordinate;
    fn move_coord(
        &self,
        coord: Self::Coordinate,
        dir: <Self::Axis as Axis>::Direction,
    ) -> Result<Self::Coordinate, Self::CoordinateMoveError>;

    // Provided methods
    fn node_count(&self) -> usize { ... }
    unsafe fn to_offset_unchecked(&self, coord: Self::Coordinate) -> Offset { ... }
    fn index_to_coordinate(&self, index: usize) -> Self::Coordinate { ... }
    fn to_index(&self, coord: Self::Coordinate) -> Option<usize> { ... }
    fn index_to_offset(&self, index: usize) -> Offset { ... }
    fn offset_to_index(&self, o: Offset) -> usize { ... }
    fn horizontal_edge_size(&self, _axis: Self::Axis) -> usize { ... }
    fn vertical_edge_size(&self, _axis: Self::Axis) -> usize { ... }
    unsafe fn move_coord_unchecked(
        &self,
        coord: Self::Coordinate,
        dir: <Self::Axis as Axis>::Direction,
    ) -> Self::Coordinate { ... }
    fn is_neighbor(&self, a: Self::Coordinate, b: Self::Coordinate) -> bool { ... }
    fn get_direction(
        &self,
        source: Self::Coordinate,
        target: Self::Coordinate,
    ) -> Option<<Self::Axis as Axis>::Direction> { ... }
}

Shape of the 2d lattice. It decides the behavior of the coordinate.

Required Associated Types

type Axis: Axis

Axis of the lattice.

type Coordinate: Coordinate

Coordinate of the lattice graph.

type OffsetConvertError: Debug + Clone

Error to return when to_offset fails. Should set Infallible when the graph is looped and never to fail.

type CoordinateMoveError: Debug + Clone

Error to return when move_coord fails. Should set Infallible when the graph is looped and never to fail.

Required Methods

fn horizontal(&self) -> usize

Horizontal node count.

fn vertical(&self) -> usize

Vertical node count.

fn to_offset( &self, coord: Self::Coordinate, ) -> Result<Offset, Self::OffsetConvertError>

Convert coordinate to Offset.

fn offset_to_coordinate(&self, offset: Offset) -> Self::Coordinate

Convert coordinate from Offset.

fn move_coord( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Result<Self::Coordinate, Self::CoordinateMoveError>

Move coordinates to the next coordinate in the direction. Coordinate should be a valid coordinate and should be checked before using move_coord. This is because the target coordinate might be valid even thought the souce coord is invalid, and some code validate the direction by moveing the coord.

Provided Methods

fn node_count(&self) -> usize

Node count.

unsafe fn to_offset_unchecked(&self, coord: Self::Coordinate) -> Offset

Convert coordinate to Offset without a check.

fn index_to_coordinate(&self, index: usize) -> Self::Coordinate

Convert coordinate from index.

fn to_index(&self, coord: Self::Coordinate) -> Option<usize>

Covert coordinate to index.

fn index_to_offset(&self, index: usize) -> Offset

Convert index to offset.

fn offset_to_index(&self, o: Offset) -> usize

Covert offset to index.

fn horizontal_edge_size(&self, _axis: Self::Axis) -> usize

👎Deprecated

Edge count of horizontal. May differ by the axis info.

fn vertical_edge_size(&self, _axis: Self::Axis) -> usize

👎Deprecated

Edge count of vertical. May differ by the axis info.

unsafe fn move_coord_unchecked( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Self::Coordinate

Move coordinates to the next coordinate in the direction. Caller should be sure that the source and the target coord is valid coord.

fn is_neighbor(&self, a: Self::Coordinate, b: Self::Coordinate) -> bool

Check whether two coordinate is in neighbor.

fn get_direction( &self, source: Self::Coordinate, target: Self::Coordinate, ) -> Option<<Self::Axis as Axis>::Direction>

Get direction if two coordiante is in neighbor.

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<S: Shape> Shape for &S

type Axis = <S as Shape>::Axis

type Coordinate = <S as Shape>::Coordinate

type OffsetConvertError = <S as Shape>::OffsetConvertError

type CoordinateMoveError = <S as Shape>::CoordinateMoveError

fn to_offset( &self, coord: Self::Coordinate, ) -> Result<Offset, Self::OffsetConvertError>

unsafe fn to_offset_unchecked(&self, coord: Self::Coordinate) -> Offset

fn offset_to_coordinate(&self, offset: Offset) -> Self::Coordinate

fn horizontal(&self) -> usize

fn vertical(&self) -> usize

fn move_coord( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Result<Self::Coordinate, Self::CoordinateMoveError>

unsafe fn move_coord_unchecked( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Self::Coordinate

fn node_count(&self) -> usize

fn index_to_coordinate(&self, index: usize) -> Self::Coordinate

fn to_index(&self, coord: Self::Coordinate) -> Option<usize>

fn index_to_offset(&self, index: usize) -> Offset

fn offset_to_index(&self, o: Offset) -> usize

fn is_neighbor(&self, a: Self::Coordinate, b: Self::Coordinate) -> bool

where Self::Coordinate: PartialEq,

fn get_direction( &self, source: Self::Coordinate, target: Self::Coordinate, ) -> Option<<Self::Axis as Axis>::Direction>

where Self::Coordinate: PartialEq,

Implementors

impl Shape for SquareDiagonalShape

type Axis = SquareDiagonalAxis

type Coordinate = SquareOffset

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl Shape for SquareDiagonalShape<Directed>

type Axis = DirectedSquareDiagonalAxis

type Coordinate = SquareOffset

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl Shape for SquareShape

type Axis = SquareAxis

type Coordinate = SquareOffset

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl Shape for SquareShape<Directed>

type Axis = DirectedSquareAxis

type Coordinate = SquareOffset

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl<B, H, V> Shape for DoubleCoordShape<B, (), H, V, AxisR>

where B: DoubleCoordShapeBase<Axis = AxisR>, H: Clone + Into<usize>, V: Clone + Into<usize>,

type Axis = <B as DoubleCoordShapeBase>::Axis

type Coordinate = DoubleCoord

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl<B, H, V> Shape for HexOffsetShape<B, LoopEW, H, V>

where B: HexOffsetShapeBaseLoopEW, H: Into<usize> + Copy, V: Into<usize> + Copy,

type Axis = <B as HexOffsetShapeBase>::Axis

type Coordinate = HexOffset

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl<B, H, V> Shape for HexOffsetShape<B, (), H, V>

where B: HexOffsetShapeBase, H: Into<usize> + Copy, V: Into<usize> + Copy,

type Axis = <B as HexOffsetShapeBase>::Axis

type Coordinate = HexOffset

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl<B, H, V, HA> Shape for HexAxialShape<B, LoopEW, H, V, HA>

where HA: AxialCoord, B: HexAxialShapeBase<HA>, H: Clone + Into<usize>, V: Clone + Into<usize>,

type Axis = <B as HexAxialShapeBase<HA>>::Axis

type Coordinate = HA

type OffsetConvertError = ()

type CoordinateMoveError = ()

impl<B, H, V, HA> Shape for HexAxialShape<B, (), H, V, HA>

where HA: AxialCoord, B: HexAxialShapeBase<HA>, H: Clone + Into<usize>, V: Clone + Into<usize>,

type Axis = <B as HexAxialShapeBase<HA>>::Axis

type Coordinate = HA

type OffsetConvertError = ()

type CoordinateMoveError = ()