Struct Vec2

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

A 2-component non-owning view of a Euclidean vector.

Guarantees

This type has the strict requirement that it can only reference a 2-component slice of f32 values. It is guaranteed to never refer to more or less than 2 entries.

Relation to Vector2

Vec2 is a non-owning equivalent of Vector2. This enables non-vector types to either Deref or provide conversion-related utilities into Vec2 types to be able to access and benefit from vector operations.

A basic example of where this can be useful is in something like a Point2 type, where it may not be implemented directly in terms of a Vector2, but can convert into a Vec2 to benefit from operations on vectors.

Implementations

impl Vec2

pub const fn from_array(array: &[f32; 2]) -> &Self

Forms a reference to a Vec2 from a 2-component f32 array.

This function is identical to from_slice_unchecked, except it is not marked unsafe.

Parameters

• array - an array containing 2 f32 values.

Examples

Basic use:

let array: [f32; 2] = [0.1, 0.42];

let vec = Vec2::from_array(&array);

assert_eq!(vec.as_ptr(), array.as_ptr());
assert_eq!(vec.x(), array[0]);
assert_eq!(vec.y(), array[1]);

pub fn from_mut_array(array: &mut [f32; 2]) -> &mut Self

Forms a mutable reference to a Vec2 from a 2-component f32 array.

This function is identical to from_mut_slice_unchecked, except it is not marked unsafe.

Parameters

• array - an array containing 2 f32 values.

Examples

Basic use:

let mut array: [f32; 2] = [0.1, 0.42];

let vec = Vec2::from_mut_array(&mut array);

assert_eq!(vec.as_ptr(), array.as_ptr());

pub const fn from_slice(slice: &[f32]) -> Result<&Self, VecError>

Forms a reference to a Vec2 from a slice of f32.

This requires that slice.len() == 2, otherwise this returns VecError.

Parameters

• slice - the slice of f32s.

Examples

Basic use:

let slice = &[0.1, 0.42];

let vec = Vec2::from_slice(slice).unwrap();

assert_eq!(vec.as_ptr(), slice.as_ptr());
assert_eq!(vec.x(), slice[0]);
assert_eq!(vec.y(), slice[1]);

Invalid size:

let slice = &[0.1];

let vec = Vec2::from_slice(slice);

assert!(vec.is_err());

pub fn from_mut_slice(slice: &mut [f32]) -> Result<&mut Self, VecError>

Forms a mutable reference to a Vec2 from a mutable slice of f32.

This requires that slice.len() == 2, otherwise this returns VecError.

Parameters

• slice - the mutable slice of f32s.

Examples

Basic use:

let slice = &mut [0.1, 0.42];

let vec = Vec2::from_mut_slice(slice).unwrap();

assert_eq!(vec.as_ptr(), slice.as_ptr());

Invalid size:

let slice = &mut [0.1];

let vec = Vec2::from_mut_slice(slice);

assert!(vec.is_err());

pub const unsafe fn from_slice_unchecked(slice: &[f32]) -> &Self

Forms a reference to a Vec2 from a slice of f32 that is assumed to contain two values.

Parameters

• slice - the slice of f32s.

Safety

slice.len() must be equal to 2.

pub unsafe fn from_mut_slice_unchecked(slice: &mut [f32]) -> &mut Self

Forms a mutable reference to a Vec2 from a slice of f32 that is assumed to contain two values.

Parameters

• slice - the mutable slice of f32s.

Safety

slice.len() must be equal to 2.

pub const unsafe fn from_ptr_unchecked<'a>(ptr: *const f32) -> &'a Vec2

Forms a reference to a Vec2 from a pointer to a contiguous sequence of at least two f32s.

Parameters

• ptr - the pointer to a sequence of f32 values

Safety

ptr must point to an allocated object that references at least two entries

pub unsafe fn from_mut_ptr_unchecked<'a>(ptr: *mut f32) -> &'a mut Vec2

Forms a mutable reference to a Vec2 from a pointer to a contiguous sequence of at least two f32s.

Parameters

• ptr - the pointer to a sequence of f32 values

Safety

ptr must point to an allocated object that references at least two entries

pub const fn as_slice(&self) -> &[f32]

Returns this Vec2 as a slice of f32.

pub fn as_mut_slice(&mut self) -> &mut [f32]

Returns this Vec2 as a mutable slice of f32.

pub const fn as_ptr(&self) -> *const f32

Returns a raw pointer to f32 of the vector’s buffer.

pub fn as_mut_ptr(&mut self) -> *mut f32

Returns a raw pointer to f32 of the vector’s buffer.

pub fn iter(&self) -> impl Iterator<Item = &f32>

Returns an iterator over the vector.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut f32>

Returns a mutable iterator over the vector.

pub const fn x(&self) -> f32

Returns the X-coordinate of this 2-component vector.

pub const fn y(&self) -> f32

Returns the Y-coordinate of this 2-component vector.

pub fn x_mut(&mut self) -> &mut f32

Returns a mutable reference to the X-coordinate of this 2-component vector.

pub fn y_mut(&mut self) -> &mut f32

Returns a mutable reference to the Y-coordinate of this 2-component vector.

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

Sets the x-component

Parameters

• x - the X-component

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

Sets the y-component

Parameters

• y - the Y-component

pub fn set(&mut self, other: &Vec2)

Sets all the components of this vector the values from other.

Parameters

• other - the other Vec2 to set.

pub fn square_magnitude(&self) -> f32

Computes the square magnitude of this two-component vector.

pub fn magnitude(&self) -> f32

Computes the magnitude of this vector.

Where possible, consider using Vec2::square_magnitude as this will avoid the need to compute the square-root.

pub fn is_normalized(&self) -> bool

Queries whether this vector is normalized (e.g. has a magnitude of 1).

pub fn normalize(&mut self)

Normalizes this vector.

pub fn normalized(&self) -> Vector2

Returns a normalized version of this vector.

pub fn rotate<A: Angle>(&mut self, angle: A)

Rotates this vector around the origin by angle A.

Parameters

• angle - the angle to rotate

pub fn rotated<A: Angle>(&self, angle: A) -> Vector2

Returns a vector rotated by the specified angle

Parameters

• angle - the angle to rotate

pub fn is_finite(&self) -> bool

Returns whether all components of this Vec are finite.

Example

Basic use:

let finite = Vector2::UNIT_X;
let not_finite = Vector2::new(f32::INFINITY, 3.0);

assert!(finite.is_finite());
assert!(!not_finite.is_finite());

pub fn is_infinite(&self) -> bool

Returns whether any component of this vec are infinite.

This is the inverse operation of is_finite.

Example

Basic use:

let finite = Vector2::UNIT_X;
let not_finite = Vector2::new(f32::INFINITY, 3.0);

assert!(!finite.is_infinite());
assert!(not_finite.is_infinite());

pub fn is_nan(&self) -> bool

Returns whether any component of this vec are nan.

Example

Basic use:

let not_nan = Vector2::UNIT_X;
let nan = Vector2::new(f32::NAN, 3.0);

assert!(!not_nan.is_nan());
assert!(nan.is_nan());

pub fn abs(&self) -> Vector2

Computes the absolute value of self

Example

Basic use:

let vec = Vector2::new(-3.0, 4.0);
let abs = vec.abs();

assert_eq!(abs, Vector2::new(3.0, 4.0));

pub fn min(&self, rhs: &Vec2) -> Vector2

Computes the minimum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

pub fn max(&self, rhs: &Vec2) -> Vector2

Computes the maximum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

Trait Implementations

impl Add<&Vec2> for &Vector2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Vec2> for Vector2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Vector2> for &Vec2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector2> for &Vec2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for &Vec2

type Output = Vector2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&Vec2> for Vec2

fn add_assign(&mut self, rhs: &Vec2)

Performs the += operation.

impl AddAssign<&Vec2> for Vector2

fn add_assign(&mut self, rhs: &Vec2)

Performs the += operation.

impl AlmostEq for Vec2

fn almost_eq(&self, other: &Self) -> bool

Tests whether self is almost equal to other

impl AsMut<[f32]> for Vec2

fn as_mut(&mut self) -> &mut [f32]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Vec2> for Vector2

fn as_mut(&mut self) -> &mut Vec2

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[f32]> for Vec2

fn as_ref(&self) -> &[f32]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Vec2> for Vector2

fn as_ref(&self) -> &Vec2

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[f32]> for Vec2

fn borrow(&self) -> &[f32]

Immutably borrows from an owned value.

impl Borrow<Vec2> for Vector2

fn borrow(&self) -> &Vec2

Immutably borrows from an owned value.

impl BorrowMut<[f32]> for Vec2

fn borrow_mut(&mut self) -> &mut [f32]

Mutably borrows from an owned value.

impl BorrowMut<Vec2> for Vector2

fn borrow_mut(&mut self) -> &mut Vec2

Mutably borrows from an owned value.

impl Cross for Vec2

type Output = f32

The output type of the Cross operation

fn cross(&self, other: &Self) -> Self::Output

Computes the cross-product of two values, and returns the result.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Display for Vec2

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

Formats the value using the given formatter.

impl Div<f32> for &Vec2

type Output = Vector2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Dot for Vec2

type Output = f32

The output of this operation.

fn dot(&self, rhs: &Self) -> Self::Output

Performs the dot-product between two values, and returns the output value.

impl From<&Vec2> for Depth

fn from(vector: &Vec2) -> Self

Converts to this type from the input type.

impl From<&Vec2> for Horizontal

fn from(vector: &Vec2) -> Self

Converts to this type from the input type.

impl From<&Vec2> for Vector2

fn from(value: &Vec2) -> Self

Converts to this type from the input type.

impl From<&Vec2> for Vertical

fn from(vector: &Vec2) -> Self

Converts to this type from the input type.

impl<I> Index<I> for Vec2

where I: SliceIndex<[f32]>,

type Output = <I as SliceIndex<[f32]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for Vec2

where I: SliceIndex<[f32]>,

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Midpoint for Vec2

type Output = Vector2

The output type

fn midpoint(&self, other: &Self) -> Self::Output

Computes the midpoint of this type, returning the result

impl Mul<&Vec2> for f32

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for &Vec2

type Output = Vector2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Near for Vec2

fn near(&self, other: &Self, tolerance: &f32) -> bool

Tests whether self is “near” other relative top the specified tolerance

impl Neg for &Vec2

type Output = Vector2

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Vec2

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

fn partial_cmp(&self, other: &Vec2) -> 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 Rem<f32> for &Vec2

type Output = Vector2

The resulting type after applying the % operator.

fn rem(self, rhs: f32) -> Self::Output

Performs the % operation.

impl RemAssign<f32> for Vec2

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl Sub<&Vec2> for &Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2) -> Self::Output

Performs the - operation.

impl Sub<&Vec2> for Vector2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2) -> Self::Output

Performs the - operation.

impl Sub<&Vector2> for &Vec2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, rhs: &Vector2) -> Self::Output

Performs the - operation.

impl Sub<Vector2> for &Vec2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, rhs: Vector2) -> Self::Output

Performs the - operation.

impl Sub for &Vec2

type Output = Vector2

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<&Vec2> for Vec2

fn sub_assign(&mut self, rhs: &Vec2)

Performs the -= operation.

impl SubAssign<&Vec2> for Vector2

fn sub_assign(&mut self, rhs: &Vec2)

Performs the -= operation.

impl ToOwned for Vec2

type Owned = Vector2

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl StructuralPartialEq for Vec2