idevice 0.1.63

A Rust library to interact with services on iOS devices.
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

// Jackson Coxson

use crate::{IdeviceError, ReadWrite, RsdService, obf};

use super::CoreDeviceError;

/// Image encoding requested from the device for [`ScreenCaptureServiceClient::take_screenshot`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ImageFormat {
    /// PNG (lossless). The format Xcode's Devices window uses.
    #[default]
    Png,
    /// JPEG (lossy, smaller).
    Jpeg,
}

impl ImageFormat {
    /// The `requestedFormat` wire value.
    pub fn as_str(self) -> &'static str {
        match self {
            ImageFormat::Png => "png",
            ImageFormat::Jpeg => "jpeg",
        }
    }
}

impl RsdService for ScreenCaptureServiceClient<Box<dyn ReadWrite>> {
    fn rsd_service_name() -> std::borrow::Cow<'static, str> {
        obf!("com.apple.coredevice.screencaptureservice")
    }

    async fn from_stream(stream: Box<dyn ReadWrite>) -> Result<Self, IdeviceError> {
        Ok(Self {
            inner: super::CoreDeviceServiceClient::new(stream).await?,
        })
    }
}

#[derive(Debug)]
pub struct ScreenCaptureServiceClient<R: ReadWrite> {
    inner: super::CoreDeviceServiceClient<R>,
}

impl<R: ReadWrite> ScreenCaptureServiceClient<R> {
    /// Capture a screenshot of `display_unique_id` (or the primary display when
    /// `None`) encoded as `format`. Returns the raw image bytes.
    pub async fn take_screenshot(
        &mut self,
        display_unique_id: Option<&str>,
        format: ImageFormat,
    ) -> Result<Vec<u8>, IdeviceError> {
        let mut req = plist::Dictionary::new();
        req.insert("requestedFormat".into(), format.as_str().into());
        if let Some(id) = display_unique_id {
            req.insert("displayUniqueID".into(), id.into());
        }

        let res = self
            .inner
            .invoke_with_plist_action(
                obf!("com.apple.coredevice.feature.capturescreenshot"),
                req,
                obf!("com.apple.coredevice.action.capturescreenshot"),
            )
            .await?;

        match res.as_dictionary().and_then(|d| d.get("image")) {
            Some(plist::Value::Data(image)) => Ok(image.clone()),
            _ => Err(CoreDeviceError::MissingField("image").into()),
        }
    }
}