Struct screeps::JsVec

pub struct JsVec<T> { /* fields omitted */ }

Reference to a JavaScript array which is expected to contain a specific type of item.

All TryFrom / TryInto conversions use type checking, but FromExpectedType / IntoExpectedType possibly don't.

The implementation for Into<Vec<T>> uses IntoExpectedType internally.

Trait notes: implements TryInto<Vec<T>>, but Vec<T> does not implement TryFrom<JsVec<T>> due to coherence issues.

Methods

impl<T> JsVec<T>

pub fn len(&self) -> usize

impl<T> JsVec<T> where
    T: FromExpectedType<Value>, 

pub fn get(&self, idx: usize) -> Option<T>

Gets an item, panicking if the types don't match and check-all-casts is enabled.

pub fn try_get(&self, idx: usize) -> Result<Option<T>, ConversionError>

Gets an item, returning an error if the types don't match and check-all-casts is enabled.

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> where
    T: FromExpectedType<Value>,  type Item = T;

pub fn iter(&self) -> Iter<T>

Iterates over elements, panicking if any are not the expected type and check-all-casts is enabled.

Important traits for TryIter<'a, T>

impl<'a, T> Iterator for TryIter<'a, T> where
    T: FromExpectedType<Value>,  type Item = Result<T, ConversionError>;

pub fn try_iter(&self) -> TryIter<T>

Iterates over elements, returning an error if any are not the expected type and check-all-casts is enabled.

Use IntoIterator::into_iter to iterate expecting all types match.

Important traits for TryIntoIter<T>

impl<T> Iterator for TryIntoIter<T> where
    T: FromExpectedType<Value>,  type Item = Result<T, ConversionError>;

pub fn try_into_iter(self) -> TryIntoIter<T>

Iterates over elements, consuming self and returning a result if any are not the expected type.

Use IntoIterator::into_iter to iterate expecting all types match.

pub fn try_local(&self) -> Result<Vec<T>, ConversionError>

Turns this remote JS array into a local Vec, returning an error if any elements are not the expected type and check-all-casts is enabled.

pub fn local(&self) -> Vec<T>

Turns this remote JS array into a local Vec, panicking if any elements are not the expected type and check-all-casts is enabled.

Trait Implementations

impl<T> FromExpectedType<Array> for JsVec<T> where
    T: InstanceOf, 

fn from_expected_type(arr: Array) -> Result<Self, ConversionError>

impl<T> FromExpectedType<Reference> for JsVec<T> where
    T: InstanceOf, 

fn from_expected_type(r: Reference) -> Result<Self, ConversionError>

impl<T> AsRef<Array> for JsVec<T>

fn as_ref(&self) -> &Array

Performs the conversion.

impl<T> AsRef<Reference> for JsVec<T>

fn as_ref(&self) -> &Reference

Performs the conversion.

impl<T> IntoIterator for JsVec<T> where
    T: FromExpectedType<Value>, 

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a JsVec<T> where
    T: FromExpectedType<Value>, 

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> From<JsVec<T>> for Array

fn from(jsv: JsVec<T>) -> Array

Performs the conversion.

impl<T> From<JsVec<T>> for Reference

fn from(jsv: JsVec<T>) -> Reference

Performs the conversion.

impl<'a, T> From<&'a [T]> for JsVec<T> where
    T: JsSerialize, 

fn from(v: &'a [T]) -> Self

Performs the conversion.

impl<'a, T> From<&'a mut [T]> for JsVec<T> where
    T: JsSerialize, 

fn from(v: &'a mut [T]) -> Self

Performs the conversion.

impl<'a, T> From<&'a Vec<T>> for JsVec<T> where
    T: JsSerialize, 

fn from(v: &'a Vec<T>) -> Self

Performs the conversion.

impl<'a, T> From<&'a mut Vec<T>> for JsVec<T> where
    T: JsSerialize, 

fn from(v: &'a mut Vec<T>) -> Self

Performs the conversion.

impl<T> From<Vec<T>> for JsVec<T> where
    T: JsSerialize, 

fn from(v: Vec<T>) -> Self

Performs the conversion.

impl<T> TryInto<Vec<T>> for JsVec<T> where
    T: TryFrom<Value, Error = ConversionError>, 

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Vec<T>, Self::Error>

Performs the conversion.

impl<T> InstanceOf for JsVec<T> where
    T: InstanceOf, 

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl<T> TryFrom<JsVec<T>> for Array

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(jsv: JsVec<T>) -> Result<Array, Self::Error>

Performs the conversion.

impl<T> TryFrom<JsVec<T>> for Reference

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(jsv: JsVec<T>) -> Result<Reference, Self::Error>

Performs the conversion.

impl<T> TryFrom<Array> for JsVec<T> where
    T: InstanceOf, 

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(arr: Array) -> Result<JsVec<T>, Self::Error>

Performs the conversion.

impl<T> TryFrom<Reference> for JsVec<T> where
    T: InstanceOf, 

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(r: Reference) -> Result<JsVec<T>, Self::Error>

Performs the conversion.

impl<T> TryFrom<Value> for JsVec<T> where
    T: InstanceOf, 

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(r: Value) -> Result<JsVec<T>, Self::Error>

Performs the conversion.

impl<T> ReferenceType for JsVec<T> where
    T: InstanceOf, 

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!