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
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! Programmatic device rotation via the `com.apple.coredevice.devicecontrol`
//! RemoteXPC service.

use std::borrow::Cow;

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

use super::CoreDeviceError;

/// Which way to rotate the device by 90 degrees.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RotationDirection {
    /// Counter-clockwise.
    Left,
    /// Clockwise.
    Right,
}

impl RotationDirection {
    /// The `rotate` wire value.
    pub fn as_str(self) -> &'static str {
        match self {
            RotationDirection::Left => "left",
            RotationDirection::Right => "right",
        }
    }
}

/// A device orientation as reported by `devicecontrol`
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Orientation {
    Portrait,
    PortraitUpsideDown,
    LandscapeLeft,
    LandscapeRight,
    FaceUp,
    FaceDown,
    /// A value the device reported that this crate doesn't have a variant for.
    Unknown(String),
}

impl Orientation {
    fn from_wire(s: &str) -> Self {
        match s {
            "portrait" => Orientation::Portrait,
            "portraitUpsideDown" => Orientation::PortraitUpsideDown,
            "landscapeLeft" => Orientation::LandscapeLeft,
            "landscapeRight" => Orientation::LandscapeRight,
            "faceUp" => Orientation::FaceUp,
            "faceDown" => Orientation::FaceDown,
            other => Orientation::Unknown(other.to_string()),
        }
    }
}

/// The device's orientation after a rotation request.
#[derive(Debug, Clone)]
pub struct OrientationState {
    pub orientation: Orientation,
    pub non_flat_orientation: Orientation,
    /// whether rotation lock is engaged.
    pub locked: bool,
}

#[derive(Debug)]
pub struct OrientationServiceClient<R: ReadWrite> {
    inner: RemoteXpcClient<R>,
}

impl RsdService for OrientationServiceClient<Box<dyn ReadWrite>> {
    fn rsd_service_name() -> Cow<'static, str> {
        obf!("com.apple.coredevice.devicecontrol")
    }

    async fn from_stream(stream: Box<dyn ReadWrite>) -> Result<Self, IdeviceError> {
        let mut inner = RemoteXpcClient::new(stream).await?;
        inner.do_handshake().await?;
        Ok(Self { inner })
    }
}

impl<R: ReadWrite> OrientationServiceClient<R> {
    pub fn new(inner: RemoteXpcClient<R>) -> Self {
        Self { inner }
    }

    /// Rotate the device 90 degrees in `direction`, returning the device's
    /// resulting [`OrientationState`].
    pub async fn rotate(
        &mut self,
        direction: RotationDirection,
    ) -> Result<OrientationState, IdeviceError> {
        let id: Cow<str> = obf!("com.apple.coredevice.feature.remote.devicecontrol.orientation");
        let msg = xpc!({
            "featureIdentifier": id.to_string(),
            "messageType": "OrientationRequest",
            "payload": {
                "rotate": {
                    "_0": direction.as_str()
                }
            }
        });

        self.inner.send_object(msg, true).await?;
        let res = self.inner.recv().await?;

        let dict = res
            .as_dictionary()
            .ok_or(CoreDeviceError::MalformedField("(root)"))?;
        let orientation = dict
            .get("currentDeviceOrientation")
            .and_then(|v| v.as_string())
            .ok_or(CoreDeviceError::MissingField("currentDeviceOrientation"))?;
        let non_flat = dict
            .get("currentDeviceNonFlatOrientation")
            .and_then(|v| v.as_string())
            .ok_or(CoreDeviceError::MissingField(
                "currentDeviceNonFlatOrientation",
            ))?;
        let locked = dict
            .get("currentDeviceOrientationLocked")
            .and_then(|v| v.as_boolean())
            .ok_or(CoreDeviceError::MissingField(
                "currentDeviceOrientationLocked",
            ))?;

        Ok(OrientationState {
            orientation: Orientation::from_wire(orientation),
            non_flat_orientation: Orientation::from_wire(non_flat),
            locked,
        })
    }
}