Struct UCoord 

pub struct UCoord(/* private fields */);

Implementations

impl UCoord

pub fn new(width: u32, height: u32) -> Self

Creates a new UCoord. Panics if width or height is greater than ::core::i32::MAX.

pub const fn new_u16(width: u16, height: u16) -> Self

Like new, but const and never panics as it’s impossible to construct an invalid ucoord

pub fn from_icoord(icoord: ICoord) -> Self

pub const fn to_icoord(self) -> ICoord

pub const fn get(self, axis: Axis) -> u32

pub fn with_axis<F: FnMut(u32) -> u32>(self, axis: Axis, f: F) -> Self

pub fn set(self, axis: Axis, value: u32) -> Self

pub fn set_in_place(&mut self, axis: Axis, value: u32)

pub fn new_axis(this_axis: u32, other_axis: u32, axis: Axis) -> Self

pub fn get_static<A: StaticAxis>(self) -> u32

pub fn with_static_axis<A: StaticAxis, F: FnMut(u32) -> u32>(self, f: F) -> Self

pub fn set_static<A: StaticAxis>(self, value: u32) -> Self

pub fn set_static_in_place<A: StaticAxis>(&mut self, value: u32)

pub fn new_static_axis<A: StaticAxis>(this_axis: u32, other_axis: u32) -> Self

pub fn set_width(self, width: u32) -> Self

pub fn set_height(self, height: u32) -> Self

pub fn set_width_in_place(&mut self, width: u32)

pub fn set_height_in_place(&mut self, height: u32)

pub const fn width(self) -> u32

Returns the width.

pub const fn height(self) -> u32

Returns the height.

pub const fn count(self) -> usize

Return the number of cells in a 2D grid of this size.

pub fn checked_sub(self, rhs: Self) -> Option<Self>

pub fn saturating_sub(self, rhs: Self) -> Self

pub const fn max_field() -> u32

pub const fn max() -> Self

pub const fn is_zero(self) -> bool

pub const fn is_valid(self, icoord: ICoord) -> bool

pub const fn constrain(self, icoord: ICoord) -> Option<ICoord>

pub const fn icoord_iter_row_major(self) -> ICoordIterRowMajor

pub fn pairwise_max(self, other: Self) -> Self

pub fn pairwise_min(self, other: Self) -> Self

pub const fn transpose(self) -> Self

pub const fn is_empty(self) -> bool

pub const fn is_on_edge(self, _: ICoord) -> bool

pub fn edge_iter(self) -> EdgeIter

Trait Implementations

impl<'a, 'b> Add<&'a ICoord> for &'b UCoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, _: &'a ICoord) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a ICoord> for UCoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, _: &'a ICoord) -> Self::Output

Performs the + operation.

impl<'a, 'b> Add<&'a UCoord> for &'b ICoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, ucoord: &'a UCoord) -> Self::Output

Performs the + operation.

impl<'a, 'b> Add<&'a UCoord> for &'b UCoord

type Output = UCoord

The resulting type after applying the + operator.

fn add(self, ucoord: &'a UCoord) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a UCoord> for ICoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, ucoord: &'a UCoord) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a UCoord> for UCoord

type Output = UCoord

The resulting type after applying the + operator.

fn add(self, ucoord: &'a UCoord) -> Self::Output

Performs the + operation.

impl<'a> Add<ICoord> for &'a UCoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, _: ICoord) -> Self::Output

Performs the + operation.

impl Add<ICoord> for UCoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, _: ICoord) -> Self::Output

Performs the + operation.

impl<'a> Add<UCoord> for &'a ICoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, ucoord: UCoord) -> Self::Output

Performs the + operation.

impl<'a> Add<UCoord> for &'a UCoord

type Output = UCoord

The resulting type after applying the + operator.

fn add(self, ucoord: UCoord) -> Self::Output

Performs the + operation.

impl Add<UCoord> for ICoord

type Output = ICoord

The resulting type after applying the + operator.

fn add(self, ucoord: UCoord) -> Self::Output

Performs the + operation.

impl Add for UCoord

type Output = UCoord

The resulting type after applying the + operator.

fn add(self, ucoord: UCoord) -> Self::Output

Performs the + operation.

impl Clone for UCoord

fn clone(&self) -> UCoord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UCoord

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

Formats the value using the given formatter.

impl Default for UCoord

fn default() -> UCoord

Returns the “default value” for a type.

impl<'a> Div<u32> for &'a UCoord

type Output = UCoord

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl Div<u32> for UCoord

type Output = UCoord

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl<T> DivAssign<T> for UCoord

where UCoord: Div<T, Output = UCoord>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<[u32; 2]> for UCoord

fn from(array: [u32; 2]) -> Self

Converts to this type from the input type.

impl From<(u32, u32)> for UCoord

fn from((x, y): (u32, u32)) -> Self

Converts to this type from the input type.

impl Hash for UCoord

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<'a> Mul<u32> for &'a UCoord

type Output = UCoord

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl Mul<u32> for UCoord

type Output = UCoord

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl<T> MulAssign<T> for UCoord

where UCoord: Mul<T, Output = UCoord>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Ord for UCoord

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

fn eq(&self, other: &UCoord) -> 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 PartialOrd for UCoord

fn partial_cmp(&self, other: &UCoord) -> 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<'a, 'b> Sub<&'a ICoord> for &'b UCoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, _: &'a ICoord) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a ICoord> for UCoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, _: &'a ICoord) -> Self::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a UCoord> for &'b ICoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, ucoord: &'a UCoord) -> Self::Output

Performs the - operation.

impl<'a, 'b> Sub<&'a UCoord> for &'b UCoord

type Output = UCoord

The resulting type after applying the - operator.

fn sub(self, ucoord: &'a UCoord) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a UCoord> for ICoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, ucoord: &'a UCoord) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a UCoord> for UCoord

type Output = UCoord

The resulting type after applying the - operator.

fn sub(self, ucoord: &'a UCoord) -> Self::Output

Performs the - operation.

impl<'a> Sub<ICoord> for &'a UCoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, _: ICoord) -> Self::Output

Performs the - operation.

impl Sub<ICoord> for UCoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, _: ICoord) -> Self::Output

Performs the - operation.

impl<'a> Sub<UCoord> for &'a ICoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, ucoord: UCoord) -> Self::Output

Performs the - operation.

impl<'a> Sub<UCoord> for &'a UCoord

type Output = UCoord

The resulting type after applying the - operator.

fn sub(self, ucoord: UCoord) -> Self::Output

Performs the - operation.

impl Sub<UCoord> for ICoord

type Output = ICoord

The resulting type after applying the - operator.

fn sub(self, ucoord: UCoord) -> Self::Output

Performs the - operation.

impl Sub for UCoord

type Output = UCoord

The resulting type after applying the - operator.

fn sub(self, ucoord: UCoord) -> Self::Output

Performs the - operation.

impl Copy for UCoord

impl Eq for UCoord

impl StructuralPartialEq for UCoord