Struct screeps::pathfinder::LocalCostMatrix

pub struct LocalCostMatrix { /* fields omitted */ }

Methods

impl LocalCostMatrix

pub fn new() -> Self

pub fn set(&mut self, x: u8, y: u8, val: u8)

pub fn get(&self, x: u8, y: u8) -> u8

pub fn upload(&self) -> CostMatrix<'static>

Copies all data into an JavaScript CostMatrix for use.

This is slower than as_uploaded, but much safer.

pub unsafe fn as_uploaded<'a>(&'a self) -> CostMatrix<'a>

Temporarily exposes the bits of this matrix as a cost matrix.

Unsafety

There are two main invariants you must uphold after using this function:

1. The CostMatrix can only be used in JS code as long as this LocalCostMatrix is alive. Doing otherwise will result in undefined behavior, mainly JS being allowed to read/ manipulate uninitialized rust memory or rust memory that's been repurposed.

2. The set method of the cost matrix must not be used - it must be read only. This takes &self, but technically allows mutation of the inner Vec via JavaScript access. You should not use this method, or you will invoke Rust undefined behavior.

The CostMatrix returned will reference the internal data of this LocalCostMatrix.

Trait Implementations

impl Clone for LocalCostMatrix

fn clone(&self) -> LocalCostMatrix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for LocalCostMatrix

fn default() -> Self

Returns the "default value" for a type.

impl Into<Vec<u8>> for LocalCostMatrix

fn into(self) -> Vec<u8>

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

impl Debug for LocalCostMatrix

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

Formats the value using the given formatter.

impl Serialize for LocalCostMatrix

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

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.