screeps-game-api 0.23.3

WASM bindings to the in-game Screeps API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

use std::{error::Error, fmt};

use num_derive::FromPrimitive;
use serde_repr::{Deserialize_repr, Serialize_repr};

use crate::{constants::ErrorCode, FromReturnCode};

/// Error codes used by
/// [ConstructionSite::remove](crate::ConstructionSite::remove).
///
/// [Screeps API Docs](https://docs.screeps.com/api/#ConstructionSite.remove).
///
/// [Screeps Engine Source Code](https://github.com/screeps/engine/blob/97c9d12385fed686655c13b09f5f2457dd83a2bf/src/game/construction-sites.js#L50)
#[derive(
    Debug, PartialEq, Eq, Clone, Copy, Hash, FromPrimitive, Deserialize_repr, Serialize_repr,
)]
#[repr(i8)]
pub enum ConstructionSiteRemoveErrorCode {
    NotOwner = -1,
}

impl FromReturnCode for ConstructionSiteRemoveErrorCode {
    type Error = Self;

    fn result_from_i8(val: i8) -> Result<(), Self::Error> {
        let maybe_result = Self::try_result_from_i8(val);
        #[cfg(feature = "unsafe-return-conversion")]
        unsafe {
            maybe_result.unwrap_unchecked()
        }
        #[cfg(not(feature = "unsafe-return-conversion"))]
        maybe_result.unwrap()
    }

    fn try_result_from_i8(val: i8) -> Option<Result<(), Self::Error>> {
        match val {
            0 => Some(Ok(())),
            -1 => Some(Err(ConstructionSiteRemoveErrorCode::NotOwner)),
            _ => None,
        }
    }
}

impl fmt::Display for ConstructionSiteRemoveErrorCode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let msg: &'static str = match self {
            ConstructionSiteRemoveErrorCode::NotOwner => {
                "you are not the owner of this construction site, and it's not in your room"
            }
        };

        write!(f, "{}", msg)
    }
}

impl Error for ConstructionSiteRemoveErrorCode {}

impl From<ConstructionSiteRemoveErrorCode> for ErrorCode {
    fn from(value: ConstructionSiteRemoveErrorCode) -> Self {
        // Safety: ConstructionSiteRemoveErrorCode is repr(i8), so we can cast it to get
        // the discriminant value, which will match the raw return code value that
        // ErrorCode expects.   Ref: https://doc.rust-lang.org/reference/items/enumerations.html#r-items.enum.discriminant.coercion.intro
        // Safety: ConstructionSiteRemoveErrorCode discriminants are always error code
        // values, and thus the Result returned here will always be an `Err` variant, so
        // we can always extract the error without panicking
        Self::result_from_i8(value as i8).unwrap_err()
    }
}