Struct Point 

#[repr(C)]
pub struct Point<X, Y = X> {
    pub x: X,
    pub y: Y,
}

The Point implementation is designed a generic, 2-dimensional point object used to define coordinates, vectors, or positions in a 2D space.

Fields

x: X

y: Y

Implementations

impl<X, Y> Point<X, Y>

pub const fn new(x: X, y: Y) -> Self

Creates a new Point.

pub fn from_tuple((x, y): (X, Y)) -> Self

create a new instance from the given 2-tuple

pub const fn x(&self) -> &X

returns a reference to the x coordinate.

pub const fn x_mut(&mut self) -> &mut X

returns a mutable reference to the x coordinate.

pub const fn y(&self) -> &Y

returns a reference to the y coordinate.

pub const fn y_mut(&mut self) -> &mut Y

returns a mutable reference to the y coordinate.

pub const fn replace_x(&mut self, x: X) -> X

replace the x value, returning the old value.

pub const fn replace_y(&mut self, y: Y) -> Y

replace the y value, returning the old value.

pub fn set_x(&mut self, x: X)

set the x value

pub fn set_y(&mut self, y: Y)

set the y value

pub fn with_x<X2>(self, x: X2) -> Point<X2, Y>

consumes the current instance to create another with the given x value.

pub fn with_y<Y2>(self, y: Y2) -> Point<X, Y2>

consumes the current instance to create another with the given y value.

pub const fn as_view(&self) -> Point<&X, &Y>

returns an owned view of the point

pub const fn as_mut_view(&mut self) -> Point<&mut X, &mut Y>

returns a view of the Point containing mutable references to the inner values.

pub const fn as_tuple(&self) -> (&X, &Y)

returns a 2-tuple containing references to the inner values.

pub fn into_tuple(self) -> (X, Y)

consumes the caller to convert the object into a 2-tuple.

impl<'a, X, Y> Point<&'a X, &'a Y>

pub fn cloned(&self) -> Point<X, Y>

where X: Clone, Y: Clone,

returns an new instance of the Point with cloned values

pub const fn copied(&self) -> Point<X, Y>

where X: Copy, Y: Copy,

return a new instance of the Point with copied values

impl<'a, X, Y> Point<&'a mut X, &'a mut Y>

pub fn cloned(&self) -> Point<X, Y>

where X: Clone, Y: Clone,

returns an new instance of the Point with cloned values

pub const fn copied(&self) -> Point<X, Y>

where X: Copy, Y: Copy,

return a new instance of the Point with copied values

Trait Implementations

impl<X: Clone, Y: Clone> Clone for Point<X, Y>

fn clone(&self) -> Point<X, Y>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<X: Debug, Y: Debug> Debug for Point<X, Y>

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

Formats the value using the given formatter.

impl<X: Default, Y: Default> Default for Point<X, Y>

fn default() -> Point<X, Y>

Returns the “default value” for a type.

impl<X> From<[X; 2]> for Point<X, X>

fn from([x, y]: [X; 2]) -> Self

Converts to this type from the input type.

impl<X, Y> From<(X, Y)> for Point<X, Y>

fn from((x, y): (X, Y)) -> Self

Converts to this type from the input type.

impl<X> From<Point<X>> for [X; 2]

fn from(point: Point<X, X>) -> Self

Converts to this type from the input type.

impl<X, Y> From<Point<X, Y>> for (X, Y)

fn from(point: Point<X, Y>) -> Self

Converts to this type from the input type.

impl<X: Hash, Y: Hash> Hash for Point<X, Y>

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<X: Ord, Y: Ord> Ord for Point<X, Y>

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

where X: PartialEq, Y: PartialEq,

fn eq(&self, (x, y): &(X, Y)) -> 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<X, Y> PartialEq<Point<X, Y>> for (X, Y)

where X: PartialEq, Y: PartialEq,

fn eq(&self, point: &Point<X, Y>) -> 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<X: PartialEq, Y: PartialEq> PartialEq for Point<X, Y>

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

fn partial_cmp(&self, other: &Point<X, Y>) -> 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<X: Copy, Y: Copy> Copy for Point<X, Y>

impl<X: Eq, Y: Eq> Eq for Point<X, Y>

impl<X, Y> StructuralPartialEq for Point<X, Y>