Struct LocalCostMatrix

pub struct LocalCostMatrix { /* private fields */ }

A matrix of pathing costs for a room, stored in Rust memory.

Use CostMatrix if a reference to data stored in JavaScript memory is preferred.

Implementations

impl LocalCostMatrix

pub const fn new() -> Self

Create a LocalCostMatrix with a default value of 0 for all positions.

Example

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

let lcm = LocalCostMatrix::new();
let pos = unsafe { RoomXY::unchecked_new(10, 10) };
assert_eq!(lcm.get(pos), 0);

pub const fn new_with_value(value: u8) -> Self

Create a LocalCostMatrix with a default value for all positions.

Example

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

let lcm = LocalCostMatrix::new_with_value(u8::MAX);
let pos = unsafe { RoomXY::unchecked_new(10, 10) };
assert_eq!(lcm.get(pos), u8::MAX);

pub fn set(&mut self, xy: RoomXY, val: u8)

pub fn get(&self, xy: RoomXY) -> u8

pub const fn get_bits(&self) -> &[u8; 2500]

pub fn iter(&self) -> impl Iterator<Item = (RoomXY, u8)> + '_

pub fn iter_mut(&mut self) -> impl Iterator<Item = (RoomXY, &mut u8)>

Trait Implementations

impl AsMut<XMajor<u8>> for LocalCostMatrix

fn as_mut(&mut self) -> &mut XMajor<u8>

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

impl AsRef<XMajor<u8>> for LocalCostMatrix

fn as_ref(&self) -> &XMajor<u8>

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

impl Clone for LocalCostMatrix

fn clone(&self) -> LocalCostMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CostMatrixGet for LocalCostMatrix

fn get_xy(&mut self, xy: RoomXY) -> u8

impl CostMatrixSet for LocalCostMatrix

fn set_xy(&mut self, xy: RoomXY, cost: u8)

impl Debug for LocalCostMatrix

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

Formats the value using the given formatter.

impl Default for LocalCostMatrix

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalCostMatrix

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CostMatrix> for LocalCostMatrix

fn from(js_matrix: &CostMatrix) -> Self

Converts to this type from the input type.

impl From<&LocalCostMatrix> for Vec<u8>

fn from(lcm: &LocalCostMatrix) -> Vec<u8>

Converts to this type from the input type.

impl From<LocalCostMatrix> for CostMatrix

fn from(matrix: LocalCostMatrix) -> Self

Converts to this type from the input type.

impl From<LocalCostMatrix> for Vec<u8>

fn from(lcm: LocalCostMatrix) -> Vec<u8>

Returns a vector of bits length ROOM_AREA, where each position is idx = ((x * ROOM_SIZE) + y).

impl Index<Position> for LocalCostMatrix

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RoomXY> for LocalCostMatrix

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<Position> for LocalCostMatrix

fn index_mut(&mut self, idx: Position) -> &mut Self::Output

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

impl IndexMut<RoomXY> for LocalCostMatrix

fn index_mut(&mut self, xy: RoomXY) -> &mut Self::Output

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

impl PartialEq for LocalCostMatrix

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LocalCostMatrix

impl StructuralPartialEq for LocalCostMatrix