Enum screeps::constants::Direction

#[repr(u8)]
pub enum Direction {
    Top = 1,
    TopRight = 2,
    Right = 3,
    BottomRight = 4,
    Bottom = 5,
    BottomLeft = 6,
    Left = 7,
    TopLeft = 8,
}

Translates direction constants.

Variants

Top = 1

TopRight = 2

Right = 3

BottomRight = 4

Bottom = 5

BottomLeft = 6

Left = 7

TopLeft = 8

Implementations

impl Direction

pub fn is_orthogonal(self) -> bool

Whether the direction is orthogonal.

Example usage:

use screeps::Direction::*;

assert_eq!(Top.is_orthogonal(), true);
assert_eq!(TopRight.is_orthogonal(), false);

pub fn is_diagonal(self) -> bool

Whether the direction is diagonal.

Example usage:

use screeps::Direction::*;

assert_eq!(Top.is_diagonal(), false);
assert_eq!(TopRight.is_diagonal(), true);

pub fn multi_rot(self, times: i8) -> Self

Rotate the direction by a specified number of steps clockwise if positive or counter-clockwise if negative.

Example usage:

use screeps::Direction::*;

assert_eq!(Top.multi_rot(1), TopRight);
assert_eq!(Top.multi_rot(2), Right);
assert_eq!(Top.multi_rot(-1), TopLeft);
assert_eq!(Top.multi_rot(-2), Left);
assert_eq!(Top.multi_rot(64), Top);

pub fn rot_cw(self) -> Self

Rotate the direction clockwise by one step.

Example usage:

use screeps::Direction::*;

assert_eq!(Top.rot_cw(), TopRight);

pub fn rot_ccw(self) -> Self

Rotate the direction counter-clockwise by one step.

Example usage:

use screeps::Direction::*;

assert_eq!(Top.rot_ccw(), TopLeft);

Trait Implementations

impl Add<Direction> for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, direction: Direction) -> Self

Performs the + operation.

impl Clone for Direction

fn clone(&self) -> Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Direction

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Direction

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

Formats the value using the given formatter.

impl From<Direction> for (i32, i32)

fn from(direction: Direction) -> (i32, i32)

Returns the change in (x, y) when moving in each direction.

impl From<Direction> for JsValue

fn from(value: Direction) -> Self

Converts to this type from the input type.

impl From<ExitDirection> for Direction

fn from(dir: ExitDirection) -> Self

Converts to this type from the input type.

impl FromPrimitive for Direction

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl FromWasmAbi for Direction

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl Hash for Direction

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 IntoWasmAbi for Direction

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCollectionIntoValue for Direction

fn into_value(self) -> JsValue

impl Neg for Direction

fn neg(self) -> Direction

Negates this direction. Top goes to Bottom, TopRight goes to BottomLeft, etc.

Example usage:

use screeps::Direction::*;

assert_eq!(-Top, Bottom);
assert_eq!(-BottomRight, TopLeft);
assert_eq!(-Left, Right);

type Output = Direction

The resulting type after applying the - operator.

impl OptionFromWasmAbi for Direction

fn is_none(val: &u32) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Direction

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for Direction

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

const CARDINALITY: usize = 8usize

Number of values of type Self.

fn next(&self) -> Option<Self>

Returns value following *self or None if this was the end.

fn previous(&self) -> Option<Self>

Returns value preceding *self or None if this was the beginning.

fn first() -> Option<Self>

Returns the first value of type Self.

fn last() -> Option<Self>

Returns the last value of type Self.

impl Serialize for Direction

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

Serialize this value into the given Serde serializer.

impl Sub<Direction> for Position

type Output = Position

The resulting type after applying the - operator.

fn sub(self, direction: Direction) -> Self

Performs the - operation.

impl TryFromJsValue for Direction

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue ) -> Result<Self, <Direction as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for Direction

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Direction]>

impl VectorIntoWasmAbi for Direction

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Direction]>) -> Self::Abi

impl WasmDescribe for Direction

fn describe()

impl WasmDescribeVector for Direction

fn describe_vector()

impl Copy for Direction

impl Eq for Direction

impl StructuralEq for Direction

impl StructuralPartialEq for Direction