oc2_hlapi_v2 0.2.0

A client for the new version of OpenComputers II's HLAPI
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! The redstone device and its associated types
//!
//! [OC2 Docs](https://fnuecke.github.io/oc2/manual/en_us/device/redstone.html)

use std::error::Error;

use serde::{Deserialize, Serialize};
use thiserror::Error;
use uuid::Uuid;

use crate::{
    client::{DeviceBase, HlapiClient, HlapiClientError},
    devices::Side,
};

#[derive(Debug, Clone)]
/// A redstone device
pub struct Redstone {
    client: HlapiClient,
    uuid: Uuid,
}

/// The possible errors for device functions
#[non_exhaustive]
#[derive(Error, Debug)]
pub enum RedstoneError {
    #[error("HLAPI client error: {0}")]
    /// HLAPI client error
    HlapiClientError(#[from] HlapiClientError),
    #[error("Invalid signal strength given")]
    /// Invalid signal strength given
    SignalStrengthInvalid,
}

/// The event that is fired when the redstone signal strength on a side changes.
///
/// This event is fired whenever the value of [`get_redstone_input`] for a side changes, so calls to
/// [`set_redstone_output`] can cause this event to be fired.
///
/// [`get_redstone_input`]: Redstone::get_redstone_input
/// [`set_redstone_output`]: Redstone::set_redstone_output
#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
pub struct RedstoneChangedEvent {
    /// The side that changed signal strength
    pub side: Side,
    /// The new strength on that side
    #[serde(rename = "value")]
    pub strength: u8,
}

impl Redstone {
    /// Gets the redstone signal strength on the specified side. Any output of this device on that
    /// side counts towards this value.
    pub fn get_redstone_input(&self, side: Side) -> Result<u8, RedstoneError> {
        Ok(self.call("getRedstoneInput", &[&side as _], &[])?.0)
    }

    /// Gets the redstone signal strength this device is emitting on the specified side
    pub fn get_redstone_output(&self, side: Side) -> Result<u8, RedstoneError> {
        Ok(self.call("getRedstoneOutput", &[&side as _], &[])?.0)
    }

    /// Sets the redstone signal strength this device is emitting on the specified side, from 0 to
    /// 15.
    pub fn set_redstone_output(&self, side: Side, strength: u8) -> Result<(), RedstoneError> {
        if strength > 15 {
            return Err(RedstoneError::SignalStrengthInvalid);
        }
        self.call::<()>("setRedstoneOutput", &[&side as _, &strength as _], &[])?;
        Ok(())
    }
}

impl DeviceBase for Redstone {
    const TYPE: &'static str = "redstone";

    type Event = RedstoneChangedEvent;

    fn new(client: HlapiClient, uuid: Uuid) -> Result<Self, HlapiClientError> {
        Ok(Self { client, uuid })
    }

    fn uuid_base(&self) -> Uuid {
        self.uuid
    }

    fn client(&self) -> &HlapiClient {
        &self.client
    }

    fn parse_event(
        typ: &str,
        data: &serde_json::Value,
    ) -> Result<Self::Event, Box<dyn Error + Send + Sync>> {
        if typ != "redstoneChanged" {
            return Err("invalid event type".into());
        }
        Ok(serde_json::from_value(data.clone())?)
    }
}