Struct screeps::memory::MemoryReference

pub struct MemoryReference(_);

A Reference to a screeps memory object

Implementations

impl MemoryReference

pub fn new() -> Self

pub unsafe fn from_reference_unchecked(reference: Reference) -> Self

Creates a MemoryReference from some JavaScript reference.

Warning: MemoryReference is only designed to work with “plain” JavaScript objects, and passing an array or a non-plain object into this method probably won’t be what you want. MemoryReference also gives access to all properties, so if this is indeed a plain object, all of its values should also be plain objects.

Passing a non-plain-object reference into this function won’t invoke undefined behavior in and of itself, but other functions can rely on MemoryReference being “plain”.

pub fn bool(&self, key: &str) -> bool

pub fn path_bool(&self, path: &str) -> bool

pub fn f64(&self, key: &str) -> Result<Option<f64>, ConversionError>

pub fn path_f64(&self, path: &str) -> Result<Option<f64>, ConversionError>

pub fn i32(&self, key: &str) -> Result<Option<i32>, ConversionError>

pub fn path_i32(&self, path: &str) -> Result<Option<i32>, ConversionError>

pub fn string(&self, key: &str) -> Result<Option<String>, ConversionError>

pub fn path_string(&self, path: &str) -> Result<Option<String>, ConversionError>

pub fn dict(&self, key: &str) -> Result<Option<MemoryReference>, ConversionError>

pub fn path_dict(
    &self,
    path: &str
) -> Result<Option<MemoryReference>, ConversionError>

pub fn dict_or_create(
    &self,
    key: &str
) -> Result<MemoryReference, UnexpectedTypeError>

Get a dictionary value or create it if it does not exist.

If the value exists but is a different type, this will return None.

pub fn keys(&self) -> Vec<String>

pub fn del(&self, key: &str)

pub fn path_del(&self, path: &str)

pub fn get<T>(
    &self,
    key: &str
) -> Result<Option<T>, <T as TryFrom<Value>>::Error>where
    T: TryFrom<Value>,

Gets a custom type. Will return None if null or undefined, and Err if incorrect type.

Example

use log::info;
use screeps::{prelude::*, Position};

let creep = screeps::game::creeps::get("mycreepname").unwrap();
let mem = creep.memory();
let pos = mem.get::<Position>("saved_pos").unwrap();
let pos = match pos {
    Some(pos) => {
        info!("found position: {}", pos);
        pos
    }
    None => {
        info!("no position. saving new one!");
        let pos = creep.pos();
        mem.set("saved_pos", pos);
        pos
    }
};
info!("final position: {}", pos);
creep.move_to(&pos);

pub fn get_path<T>(
    &self,
    path: &str
) -> Result<Option<T>, <T as TryFrom<Value>>::Error>where
    T: TryFrom<Value>,

Gets a custom type at a memory path. Will return None if null or undefined, and Err if incorrect type.

Uses lodash in JavaScript to evaluate the path. See https://lodash.com/docs/#get.

pub fn set<T>(&self, key: &str, value: T)where
    T: JsSerialize,

pub fn path_set<T>(&self, path: &str, value: T)where
    T: JsSerialize,

pub fn arr<T>(&self, key: &str) -> Result<Option<Vec<T>>, ConversionError>where
    T: TryFrom<Value, Error = ConversionError>,

pub fn path_arr<T>(&self, path: &str) -> Result<Option<Vec<T>>, ConversionError>where
    T: TryFrom<Value, Error = ConversionError>,

Trait Implementations

impl AsRef<Reference> for MemoryReference

fn as_ref(&self) -> &Reference

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

impl Default for MemoryReference

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<Value> for MemoryReference

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.