Struct Vec2u

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

A 2-component non-owning view of an unsigned Euclidean vector.

Guarantees

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

Relation to Vector2u

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

Implementations

impl Vec2u

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

Forms a reference to a Vec2u from a 2-component u32 array.

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

Parameters

• array - an array containing 2 u32 values.

Examples

Basic use:

let array: [u32; 2] = [1, 42];

let vec = Vec2u::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 [u32; 2]) -> &mut Self

Forms a mutable reference to a Vec2u from a 2-component u32 array.

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

Parameters

• array - an array containing 2 u32 values.

Examples

Basic use:

let mut array: [u32; 2] = [1, 42];

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

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

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

Forms a reference to a [Vec2] from a slice of u32.

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

Parameters

• slice - the slice of u32s.

Examples

Basic use:

let slice = &[1, 42];

let vec = Vec2u::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 = &[1];

let vec = Vec2u::from_slice(slice);

assert!(vec.is_err());

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

Forms a mutable reference to a [Vec2] from a mutable slice of u32.

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

Parameters

• slice - the mutable slice of u32s.

Examples

Basic use:

let slice = &mut [1, 42];

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

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

Invalid size:

let slice = &mut [1];

let vec = Vec2u::from_mut_slice(slice);

assert!(vec.is_err());

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

Forms a reference to a [Vec2] from a slice of u32 that is assumed to contain two values.

Parameters

• slice - the slice of u32s.

Safety

slice.len() must be equal to 2.

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

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

Parameters

• slice - the mutable slice of u32s.

Safety

slice.len() must be equal to 2.

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

Forms a reference to a [Vec2] from a pointer to a contiguous sequence of at least two u32s.

Parameters

• ptr - the pointer to a sequence of u32 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 u32) -> &'a mut Vec2u

Forms a mutable reference to a [Vec2] from a pointer to a contiguous sequence of at least two u32s.

Parameters

• ptr - the pointer to a sequence of u32 values

Safety

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

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

Returns this [Vec2] as a slice of u32.

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

Returns this [Vec2] as a mutable slice of u32.

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

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

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

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

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

Returns an iterator over the vector.

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

Returns a mutable iterator over the vector.

pub const fn x(&self) -> u32

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

pub const fn y(&self) -> u32

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

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

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

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

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

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

Sets the x-component

Parameters

• x - the X-component

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

Sets the y-component

Parameters

• y - the Y-component

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

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

Parameters

• other - the other [Vec2] to set.

pub fn min(&self, rhs: &Vec2u) -> Vector2u

Computes the minimum of each vector.

Parameters

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

pub fn max(&self, rhs: &Vec2u) -> Vector2u

Computes the maximum of each vector.

Parameters

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

Trait Implementations

impl Add<&Vec2u> for &Vector2u

type Output = Vector2u

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Vec2u> for Vector2u

type Output = Vector2u

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Vector2u> for &Vec2u

type Output = Vector2u

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector2u> for &Vec2u

type Output = Vector2u

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for &Vec2u

type Output = Vector2u

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&Vec2u> for Vec2u

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

Performs the += operation.

impl AddAssign<&Vec2u> for Vector2u

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

Performs the += operation.

impl AsMut<[u32]> for Vec2u

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

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

impl AsMut<Vec2u> for Vector2u

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

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

impl AsRef<[u32]> for Vec2u

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

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

impl AsRef<Vec2u> for Vector2u

fn as_ref(&self) -> &Vec2u

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

impl Borrow<[u32]> for Vec2u

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

Immutably borrows from an owned value.

impl Borrow<Vec2u> for Vector2u

fn borrow(&self) -> &Vec2u

Immutably borrows from an owned value.

impl BorrowMut<[u32]> for Vec2u

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

Mutably borrows from an owned value.

impl BorrowMut<Vec2u> for Vector2u

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

Mutably borrows from an owned value.

impl Debug for Vec2u

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

Formats the value using the given formatter.

impl Display for Vec2u

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

Formats the value using the given formatter.

impl Div<u32> for &Vec2u

type Output = Vector2u

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<u32> for Vec2u

fn div_assign(&mut self, rhs: u32)

Performs the /= operation.

impl Dot for Vec2u

type Output = u32

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<&Vec2u> for Vector2

fn from(value: &Vec2u) -> Self

Converts to this type from the input type.

impl From<&Vec2u> for Vector2u

fn from(value: &Vec2u) -> Self

Converts to this type from the input type.

impl<I> Index<I> for Vec2u

where I: SliceIndex<[u32]>,

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

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for Vec2u

where I: SliceIndex<[u32]>,

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

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

impl Mul<&Vec2u> for u32

type Output = Vector2u

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u32> for &Vec2u

type Output = Vector2u

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<u32> for Vec2u

fn mul_assign(&mut self, rhs: u32)

Performs the *= operation.

impl Ord for Vec2u

fn cmp(&self, other: &Vec2u) -> Ordering

This method returns an Ordering between self and other.

impl PartialEq for Vec2u

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

fn partial_cmp(&self, other: &Vec2u) -> 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<u32> for &Vec2u

type Output = Vector2u

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<u32> for Vec2u

fn rem_assign(&mut self, rhs: u32)

Performs the %= operation.

impl Sub<&Vec2u> for &Vector2u

type Output = Vector2u

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Vec2u> for Vector2u

type Output = Vector2u

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Vector2u> for &Vec2u

type Output = Vector2u

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector2u> for &Vec2u

type Output = Vector2u

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for &Vec2u

type Output = Vector2u

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&Vec2u> for Vec2u

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

Performs the -= operation.

impl SubAssign<&Vec2u> for Vector2u

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

Performs the -= operation.

impl ToOwned for Vec2u

type Owned = Vector2u

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 Eq for Vec2u

impl StructuralPartialEq for Vec2u