Struct ingrid::Offset

pub struct Offset {
    pub x: isize,
    pub y: isize,
}

A two-dimensional offset

This structure defines a basic two-dimensional offset to shift values during some operations on grid. It enables copy semantics to avoid handling ownership and references throughout your code for no significant performance. Also, in practice, you use the offset! macro helper to instantiate offsets; this is to be consistent with the use of coordinates.

Examples

// Create a size to shift the elements of a grid.
let mut offset1 = offset!(-1, 1);

// Copy the offset into another variable.
let offset2 = offset1;

// The first variable is still accessible.
offset1.x = 1;
offset1.y = -1;

// Additionally, you could also type the following.
let offset3 = Offset::zero();

Fields

x: isize

The offset value on the X axis.

y: isize

The offset value on the Y axis.

Methods

impl Offset

pub fn new(x: isize, y: isize) -> Offset

Construct a new offset.

This function constructs a new offset from given X and Y values.

Examples

let offset = Offset::new(-1, 1);

assert_eq!(offset.x, -1);
assert_eq!(offset.y, 1);

pub fn zero() -> Offset

Construct a zero offset.

This function constructs a 'zero' offset which is a offset with both x and y values set at 0.

Examples

let offset = Offset::zero();

assert_eq!(offset.x, 0);
assert_eq!(offset.y, 0);

Trait Implementations

impl Clone for Offset

fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Offset

impl Debug for Offset

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

Formats the value using the given formatter.

impl Eq for Offset

impl PartialEq<Offset> for Offset

fn eq(&self, other: &Offset) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Offset) -> bool

This method tests for !=.

impl StructuralEq for Offset

impl StructuralPartialEq for Offset