Struct screeps::local::RoomCoordinate

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

An X or Y coordinate in a room, restricted to the valid range of coordinates.

Implementations

impl RoomCoordinate

pub const fn new(coord: u8) -> Result<Self, OutOfBoundsError>

Create a RoomCoordinate from a u8, returning an error if the coordinate is not in the valid room size range

pub unsafe fn unchecked_new(coord: u8) -> Self

Create a RoomCoordinate from a u8, without checking whether it’s in the range of valid values.

Safety

Calling this method with coord >= ROOM_SIZE can result in undefined behaviour when the resulting RoomCoordinate is used.

pub const fn u8(self) -> u8

Get the integer value of this coordinate

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

Get the coordinate adjusted by a certain value, returning None if the result is outside the valid range.

Example usage:

use screeps::local::RoomCoordinate;

let zero = RoomCoordinate::new(0).unwrap();
let forty_nine = RoomCoordinate::new(49).unwrap();

assert_eq!(zero.checked_add(1), Some(RoomCoordinate::new(1).unwrap()));
assert_eq!(zero.checked_add(-1), None);
assert_eq!(zero.checked_add(49), Some(forty_nine));
assert_eq!(forty_nine.checked_add(1), None);

pub fn saturating_add(self, rhs: i8) -> RoomCoordinate

Get the coordinate adjusted by a certain value, saturating at the edges of the room if the result would be outside of the valid range.

Example usage:

use screeps::local::RoomCoordinate;

let zero = RoomCoordinate::new(0).unwrap();
let forty_nine = RoomCoordinate::new(49).unwrap();

assert_eq!(zero.saturating_add(1), RoomCoordinate::new(1).unwrap());
assert_eq!(zero.saturating_add(-1), zero);
assert_eq!(zero.saturating_add(i8::MAX), forty_nine);
assert_eq!(forty_nine.saturating_add(1), forty_nine);
assert_eq!(forty_nine.saturating_add(i8::MIN), zero);

Trait Implementations

impl Clone for RoomCoordinate

fn clone(&self) -> RoomCoordinate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomCoordinate

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

Formats the value using the given formatter.

impl Default for RoomCoordinate

fn default() -> RoomCoordinate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomCoordinate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RoomCoordinate

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

Formats the value using the given formatter.

impl From<RoomCoordinate> for u8

fn from(coord: RoomCoordinate) -> u8

Converts to this type from the input type.

impl Hash for RoomCoordinate

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 Ord for RoomCoordinate

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

Restrict a value to a certain interval.

impl PartialEq for RoomCoordinate

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RoomCoordinate

fn partial_cmp(&self, other: &RoomCoordinate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RoomCoordinate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u8> for RoomCoordinate

type Error = OutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(coord: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for RoomCoordinate

impl Eq for RoomCoordinate

impl StructuralEq for RoomCoordinate

impl StructuralPartialEq for RoomCoordinate