screeps/enums/action_error_codes/
structurelink_error_codes.rs

1use std::{error::Error, fmt};
2
3use num_derive::FromPrimitive;
4use serde_repr::{Deserialize_repr, Serialize_repr};
5
6use crate::{constants::ErrorCode, FromReturnCode};
7
8/// Error codes used by
9/// [StructureLink::transfer_energy](crate::StructureLink::transfer_energy).
10///
11/// [Screeps API Docs](https://docs.screeps.com/api/#StructureLink.transferEnergy).
12///
13/// [Screeps Engine Source Code](https://github.com/screeps/engine/blob/97c9d12385fed686655c13b09f5f2457dd83a2bf/src/game/structures.js#L488)
14#[derive(
15    Debug, PartialEq, Eq, Clone, Copy, Hash, FromPrimitive, Deserialize_repr, Serialize_repr,
16)]
17#[repr(i8)]
18pub enum TransferEnergyErrorCode {
19    NotOwner = -1,
20    NotEnoughEnergy = -6,
21    InvalidTarget = -7,
22    Full = -8,
23    NotInRange = -9,
24    InvalidArgs = -10,
25    Tired = -11,
26    RclNotEnough = -14,
27}
28
29impl FromReturnCode for TransferEnergyErrorCode {
30    type Error = Self;
31
32    fn result_from_i8(val: i8) -> Result<(), Self::Error> {
33        let maybe_result = Self::try_result_from_i8(val);
34        #[cfg(feature = "unsafe-return-conversion")]
35        unsafe {
36            maybe_result.unwrap_unchecked()
37        }
38        #[cfg(not(feature = "unsafe-return-conversion"))]
39        maybe_result.unwrap()
40    }
41
42    fn try_result_from_i8(val: i8) -> Option<Result<(), Self::Error>> {
43        match val {
44            0 => Some(Ok(())),
45            -1 => Some(Err(TransferEnergyErrorCode::NotOwner)),
46            -6 => Some(Err(TransferEnergyErrorCode::NotEnoughEnergy)),
47            -7 => Some(Err(TransferEnergyErrorCode::InvalidTarget)),
48            -8 => Some(Err(TransferEnergyErrorCode::Full)),
49            -9 => Some(Err(TransferEnergyErrorCode::NotInRange)),
50            -10 => Some(Err(TransferEnergyErrorCode::InvalidArgs)),
51            -11 => Some(Err(TransferEnergyErrorCode::Tired)),
52            -14 => Some(Err(TransferEnergyErrorCode::RclNotEnough)),
53            _ => None,
54        }
55    }
56}
57
58impl fmt::Display for TransferEnergyErrorCode {
59    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
60        let msg: &'static str = match self {
61            TransferEnergyErrorCode::NotOwner => "you are not the owner of this link",
62            TransferEnergyErrorCode::NotEnoughEnergy => {
63                "the structure does not have the given amount of energy"
64            }
65            TransferEnergyErrorCode::InvalidTarget => {
66                "the target is not a valid structurelink object"
67            }
68            TransferEnergyErrorCode::Full => "the target cannot receive any more energy",
69            TransferEnergyErrorCode::NotInRange => "the target is too far away",
70            TransferEnergyErrorCode::InvalidArgs => "the energy amount is incorrect",
71            TransferEnergyErrorCode::Tired => "the link is still cooling down",
72            TransferEnergyErrorCode::RclNotEnough => {
73                "room controller level insufficient to use this link"
74            }
75        };
76
77        write!(f, "{}", msg)
78    }
79}
80
81impl Error for TransferEnergyErrorCode {}
82
83impl From<TransferEnergyErrorCode> for ErrorCode {
84    fn from(value: TransferEnergyErrorCode) -> Self {
85        // Safety: TransferEnergyErrorCode is repr(i8), so we can cast it to get the
86        // discriminant value, which will match the raw return code value that ErrorCode
87        // expects.   Ref: https://doc.rust-lang.org/reference/items/enumerations.html#r-items.enum.discriminant.coercion.intro
88        // Safety: TransferEnergyErrorCode discriminants are always error code values,
89        // and thus the Result returned here will always be an `Err` variant, so we can
90        // always extract the error without panicking
91        Self::result_from_i8(value as i8).unwrap_err()
92    }
93}
screeps/enums/action_error_codes/structurelink_error_codes.rs

screeps/enums/action_error_codes/
structurelink_error_codes.rs
