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

use std::{convert::Infallible, num::NonZeroU8};

use uuid::Uuid;

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

#[derive(Debug, Clone)]
/// A lectern device
///
/// [OC2 Docs](https://fnuecke.github.io/oc2/manual/en_us/device/lectern.html)
pub struct Lectern {
    client: HlapiClient,
    uuid: Uuid,
}

impl Lectern {
    /// Gets the page the book on the lectern is open at. 0 can mean the first page or an empty
    /// book, check if [`get_page_count`] is [`Some`] or not to confirm what a 0 return
    /// value means.
    ///
    /// [`get_page_count`]: Lectern::get_page_count
    pub fn get_page(&self) -> Result<u8, HlapiClientError> {
        Ok(self.call("getPage", &[], &[])?.0)
    }

    /// Gets how many pages the book on the lectern has. [`None`] if there is no book on the
    /// lectern.
    pub fn get_page_count(&self) -> Result<Option<NonZeroU8>, HlapiClientError> {
        let raw = self.call("getPageCount", &[], &[])?.0;
        Ok(NonZeroU8::new(raw))
    }
}

impl DeviceBase for Lectern {
    const TYPE: &'static str = "lectern";

    type Event = Infallible;

    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
    }
}