Struct Position8 

pub struct Position8 { /* private fields */ }

A 2D position using a clamped i8.

Implementations

impl Position8

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

Defines a new Position with the given dimensions.

pub const fn x(&self) -> i8

Get x.

pub const fn y(&self) -> i8

Get y.

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

Set x.

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

Set y.

pub fn swap(&mut self)

Swaps the x, y values.

pub const fn swapped(&self) -> Position8

Returns a new Position8 with the x, y values swapped.

impl Position8

conversions

pub const fn as_tuple(&self) -> (i8, i8)

pub const fn from_tuple(tup: (i8, i8)) -> Position8

pub const fn as_tuple_i32(&self) -> (i32, i32)

pub const fn from_tuple_i32(tup: (i32, i32)) -> Position8

pub const fn as_tuple_u32(&self) -> (u32, u32)

pub const fn from_tuple_u32(tup: (u32, u32)) -> Position8

pub const fn as_tuple_u16(&self) -> (u16, u16)

pub const fn from_tuple_u16(tup: (u16, u16)) -> Position8

pub const fn as_tuple_i16(&self) -> (i16, i16)

pub const fn from_tuple_i16(tup: (i16, i16)) -> Position8

pub const fn as_tuple_usize(&self) -> (usize, usize)

pub const fn from_tuple_usize(tup: (usize, usize)) -> Position8

impl Position8

arithmetic ops.

pub const fn saturating_add(&self, rhs: Position8) -> Position8

Saturating, clamped addition of two Position8.

pub const fn wrapping_add(&self, rhs: Position8) -> Position8

Wrapping, clamped addition of two Position8.

pub fn checked_add(&self, rhs: Position8) -> Option<Position8>

Checked, clamped addition of two Position8.

pub const fn saturating_sub(&self, rhs: Position8) -> Position8

Saturating, clamped addition of two Position8.

pub const fn wrapping_sub(&self, rhs: Position8) -> Position8

Wrapping, clamped addition of two Position8.

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

Checked, clamped addition of two Position8.

pub const fn saturating_mul(&self, rhs: Position8) -> Position8

Saturating, clamped multiplication of two Position8.

pub const fn wrapping_mul(&self, rhs: Position8) -> Position8

Wrapping, clamped multiplication of two Position8.

pub fn checked_mul(&self, rhs: Position8) -> Option<Position8>

Checked, clamped multiplication of two Position8.

pub const fn saturating_div(&self, rhs: Position8) -> Position8

Saturating, clamped division of two Position8.

pub const fn wrapping_div(&self, rhs: Position8) -> Position8

Wrapping, clamped division of two Position8.

pub fn checked_div(&self, rhs: Position8) -> Option<Position8>

Checked, clamped division of two Position8.

pub const fn saturating_add_value(&self, value: i8) -> Position8

Saturating, clamped addition of a Position8 with a value``.

pub const fn wrapping_add_value(&self, value: i8) -> Position8

Wrapping, clamped addition of a Position8 with a value``.

pub fn checked_add_value(&self, value: i8) -> Option<Position8>

Checked, clamped addition of a Position8 with a value``.

pub const fn saturating_sub_value(&self, value: i8) -> Position8

Saturating, clamped substraction of a Position8 with a value``.

pub const fn wrapping_sub_value(&self, value: i8) -> Position8

Wrapping, clamped substraction of a Position8 with a value``.

pub fn checked_sub_value(&self, value: i8) -> Option<Position8>

Checked, clamped substraction of a Position8 with a value``.

pub const fn saturating_mul_value(&self, value: i8) -> Position8

Saturating, clamped multiplication of a Position8 with a value``.

pub const fn wrapping_mul_value(&self, value: i8) -> Position8

Wrapping, clamped multiplication of a Position8 with a value``.

pub fn checked_mul_value(&self, value: i8) -> Option<Position8>

Checked, clamped multiplication of a Position8 with a value``.

pub const fn saturating_div_value(&self, value: i8) -> Position8

Saturating, clamped division of a Position8 with a value``.

pub const fn wrapping_div_value(&self, value: i8) -> Position8

Wrapping, clamped division of a Position8 with a value``.

pub fn checked_div_value(&self, value: i8) -> Option<Position8>

Checked, clamped division of a Position8 with a value``.

Trait Implementations

impl Add<i8> for Position8

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

Saturating, clamped addition.

type Output = Position8

The resulting type after applying the + operator.

impl Add for Position8

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

Saturating, clamped addition.

type Output = Position8

The resulting type after applying the + operator.

impl Clone for Position8

fn clone(&self) -> Position8

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Position8

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

Formats the value using the given formatter.

impl Default for Position8

fn default() -> Position8

Returns the “default value” for a type.

impl Display for Position8

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

Formats the value using the given formatter.

impl Div<i8> for Position8

fn div(self, rhs: i8) -> Self

Saturating, clamped division.

type Output = Position8

The resulting type after applying the / operator.

impl Div for Position8

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

Saturating, clamped division.

type Output = Position8

The resulting type after applying the / operator.

impl From<(i16, i16)> for Position8

fn from(tup: (i16, i16)) -> Position8

Converts to this type from the input type.

impl From<(i32, i32)> for Position8

fn from(tup: (i32, i32)) -> Position8

Converts to this type from the input type.

impl From<(u16, u16)> for Position8

fn from(tup: (u16, u16)) -> Position8

Converts to this type from the input type.

impl From<(u32, u32)> for Position8

fn from(tup: (u32, u32)) -> Position8

Converts to this type from the input type.

impl From<(usize, usize)> for Position8

fn from(tup: (usize, usize)) -> Position8

Converts to this type from the input type.

impl From<Position8> for (i16, i16)

fn from(s: Position8) -> (i16, i16)

Converts to this type from the input type.

impl From<Position8> for (i32, i32)

fn from(p: Position8) -> (i32, i32)

Converts to this type from the input type.

impl From<Position8> for (u16, u16)

fn from(s: Position8) -> (u16, u16)

Converts to this type from the input type.

impl From<Position8> for (u32, u32)

fn from(p: Position8) -> (u32, u32)

Converts to this type from the input type.

impl From<Position8> for (usize, usize)

fn from(p: Position8) -> (usize, usize)

Converts to this type from the input type.

impl Mul<i8> for Position8

fn mul(self, rhs: i8) -> Self

Saturating, clamped multiplication.

type Output = Position8

The resulting type after applying the * operator.

impl Mul for Position8

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

Saturating, clamped multiplication.

type Output = Position8

The resulting type after applying the * operator.

impl Ord for Position8

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

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

fn partial_cmp(&self, other: &Position8) -> 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 Sub<i8> for Position8

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

Saturating, clamped addition.

type Output = Position8

The resulting type after applying the - operator.

impl Sub for Position8

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

Saturating, clamped addition.

type Output = Position8

The resulting type after applying the - operator.

impl Copy for Position8

impl Eq for Position8

impl StructuralPartialEq for Position8