Struct RoomOffset

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

An offset between two coordinates in a room. Restricted to the open range (-ROOM_SIZE, ROOM_SIZE). This bound can be used in safety constraints.

Implementations

impl RoomOffset

pub const MAX: Self

pub const MIN: Self

pub const fn new(offset: i8) -> Result<Self, OffsetOutOfBoundsError>

Create a RoomOffset from an i8, returning an error if it’s not within the valid range.

pub unsafe fn unchecked_new(offset: i8) -> Self

Create a RoomOffset from an i8, without checking whether it’s in the range of valid values.

Safety

Calling this method with offset.abs() >= ROOM_SIZE_I8 can result in undefined behaviour when the resulting RoomOffset is used.

pub fn assume_bounds_constraint(self)

Provides a hint to the compiler that the contained i8 is within (-ROOM_SIZE_I8, ROOM_SIZE_I8). Allows for better optimized safe code that uses this property.

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

Add two offsets together, returning None if the result would be outside the valid range.

Example usage:

use screeps::local::RoomOffset;

let zero = RoomOffset::new(0).unwrap();
let one = RoomOffset::new(1).unwrap();

assert_eq!(RoomOffset::MIN.checked_add(RoomOffset::MAX), Some(zero));
assert_eq!(RoomOffset::MAX.checked_add(one), None);
assert_eq!(RoomOffset::MIN.checked_add(-one), None);

pub fn saturating_add(self, rhs: Self) -> Self

Add two offsets together, saturating at the boundaries of the valid range if the result would be outside.

Example usage:

use screeps::local::RoomOffset;

let zero = RoomOffset::new(0).unwrap();
let one = RoomOffset::new(1).unwrap();

assert_eq!(RoomOffset::MIN.saturating_add(RoomOffset::MAX), zero);
assert_eq!(RoomOffset::MAX.saturating_add(one), RoomOffset::MAX);
assert_eq!(RoomOffset::MIN.saturating_add(-one), RoomOffset::MIN);

pub fn overflowing_add(self, rhs: Self) -> (Self, bool)

Add two offsets together, wrapping around at the ends of the valid range. Returns a bool indicating whether there was wrapping.

Example usage:

use screeps::local::RoomOffset;

let zero = RoomOffset::new(0).unwrap();
let one = RoomOffset::new(1).unwrap();

assert_eq!(
    RoomOffset::MAX.overflowing_add(one),
    (RoomOffset::MIN, true)
);
assert_eq!(
    RoomOffset::MIN.overflowing_add(-one),
    (RoomOffset::MAX, true)
);
assert_eq!(
    RoomOffset::MIN.overflowing_add(RoomOffset::MAX),
    (zero, false)
);

pub fn wrapping_add(self, rhs: Self) -> Self

Add two offsets together, wrapping around at the ends of the valid range.

Example usage:

use screeps::local::RoomOffset;

let zero = RoomOffset::new(0).unwrap();
let one = RoomOffset::new(1).unwrap();

assert_eq!(RoomOffset::MAX.wrapping_add(one), RoomOffset::MIN);
assert_eq!(RoomOffset::MIN.wrapping_add(-one), RoomOffset::MAX);
assert_eq!(RoomOffset::MIN.wrapping_add(RoomOffset::MAX), zero);

pub unsafe fn unchecked_add(self, rhs: Self) -> Self

Add two offsets together, without checking that the result is in the valid range.

Safety

The result of adding the two offsets as integers must lie within (-ROOM_SIZE_I8, ROOM_SIZE_I8).

pub fn abs(self) -> u8

Get the absolute value of the offset.

Can be used for distance computations, e.g.

use screeps::local::{RoomOffset, RoomXY};

fn get_movement_distance(a: RoomXY, b: RoomXY) -> u8 {
    (a.x - b.x).abs().max((a.y - b.y).abs())
}

Trait Implementations

impl AsRef<i8> for RoomOffset

fn as_ref(&self) -> &i8

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

impl Clone for RoomOffset

fn clone(&self) -> RoomOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomOffset

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

Formats the value using the given formatter.

impl Default for RoomOffset

fn default() -> RoomOffset

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomOffset

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RoomOffset> for i8

fn from(offset: RoomOffset) -> i8

Converts to this type from the input type.

impl Hash for RoomOffset

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 Neg for RoomOffset

type Output = RoomOffset

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for RoomOffset

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i8> for RoomOffset

type Error = OffsetOutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(offset: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for RoomOffset

impl Eq for RoomOffset

impl StructuralPartialEq for RoomOffset