mtp-rs 0.13.1

Pure-Rust MTP (Media Transfer Protocol) library for modern Android 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

//! Device events.

use crate::ptp::{EventCode, EventContainer, ObjectHandle, StorageId};

/// Events from an MTP device.
#[derive(Debug, Clone)]
pub enum DeviceEvent {
    /// A new object was added.
    ObjectAdded {
        /// Handle of the new object.
        handle: ObjectHandle,
    },

    /// An object was removed.
    ObjectRemoved {
        /// Handle of the removed object.
        handle: ObjectHandle,
    },

    /// A storage was added (e.g., SD card inserted).
    StoreAdded {
        /// ID of the new storage.
        storage_id: StorageId,
    },

    /// A storage was removed.
    StoreRemoved {
        /// ID of the removed storage.
        storage_id: StorageId,
    },

    /// Storage info changed (e.g., free space).
    StorageInfoChanged {
        /// ID of the storage that changed.
        storage_id: StorageId,
    },

    /// Object info changed.
    ObjectInfoChanged {
        /// Handle of the object that changed.
        handle: ObjectHandle,
    },

    /// Device info changed.
    DeviceInfoChanged,

    /// Device is being reset.
    DeviceReset,

    /// Unknown event.
    Unknown {
        /// Raw event code.
        code: u16,
        /// Event parameters.
        params: [u32; 3],
    },
}

impl DeviceEvent {
    /// Parse from an event container.
    #[must_use]
    pub fn from_container(container: &EventContainer) -> Self {
        match container.code {
            EventCode::ObjectAdded => DeviceEvent::ObjectAdded {
                handle: ObjectHandle(container.params[0]),
            },
            EventCode::ObjectRemoved => DeviceEvent::ObjectRemoved {
                handle: ObjectHandle(container.params[0]),
            },
            EventCode::StoreAdded => DeviceEvent::StoreAdded {
                storage_id: StorageId(container.params[0]),
            },
            EventCode::StoreRemoved => DeviceEvent::StoreRemoved {
                storage_id: StorageId(container.params[0]),
            },
            EventCode::StorageInfoChanged => DeviceEvent::StorageInfoChanged {
                storage_id: StorageId(container.params[0]),
            },
            EventCode::ObjectInfoChanged => DeviceEvent::ObjectInfoChanged {
                handle: ObjectHandle(container.params[0]),
            },
            EventCode::DeviceInfoChanged => DeviceEvent::DeviceInfoChanged,
            // All other codes (including Unknown and unhandled known codes like DevicePropChanged)
            other => DeviceEvent::Unknown {
                code: other.into(),
                params: container.params,
            },
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn event_parsing() {
        // Events with object handle param
        for (code, expected_handle) in [
            (EventCode::ObjectAdded, 42),
            (EventCode::ObjectRemoved, 123),
            (EventCode::ObjectInfoChanged, 99),
        ] {
            let container = EventContainer {
                code,
                transaction_id: 0,
                params: [expected_handle, 0, 0],
            };
            let event = DeviceEvent::from_container(&container);
            let handle = match event {
                DeviceEvent::ObjectAdded { handle } => handle,
                DeviceEvent::ObjectRemoved { handle } => handle,
                DeviceEvent::ObjectInfoChanged { handle } => handle,
                _ => panic!("Unexpected event type"),
            };
            assert_eq!(handle, ObjectHandle(expected_handle));
        }

        // Events with storage ID param
        for (code, expected_id) in [
            (EventCode::StoreAdded, 0x00010001),
            (EventCode::StoreRemoved, 0x00010002),
            (EventCode::StorageInfoChanged, 0x00010001),
        ] {
            let container = EventContainer {
                code,
                transaction_id: 0,
                params: [expected_id, 0, 0],
            };
            let event = DeviceEvent::from_container(&container);
            let storage_id = match event {
                DeviceEvent::StoreAdded { storage_id } => storage_id,
                DeviceEvent::StoreRemoved { storage_id } => storage_id,
                DeviceEvent::StorageInfoChanged { storage_id } => storage_id,
                _ => panic!("Unexpected event type"),
            };
            assert_eq!(storage_id, StorageId(expected_id));
        }

        // DeviceInfoChanged (no params)
        let container = EventContainer {
            code: EventCode::DeviceInfoChanged,
            transaction_id: 0,
            params: [0, 0, 0],
        };
        assert!(matches!(
            DeviceEvent::from_container(&container),
            DeviceEvent::DeviceInfoChanged
        ));
    }

    #[test]
    fn unknown_events() {
        // Explicit Unknown code
        let container = EventContainer {
            code: EventCode::Unknown(0x9999),
            transaction_id: 0,
            params: [1, 2, 3],
        };
        match DeviceEvent::from_container(&container) {
            DeviceEvent::Unknown { code, params } => {
                assert_eq!(code, 0x9999);
                assert_eq!(params, [1, 2, 3]);
            }
            _ => panic!("Expected Unknown event"),
        }

        // Known EventCode without DeviceEvent variant (DevicePropChanged)
        let container = EventContainer {
            code: EventCode::DevicePropChanged,
            transaction_id: 0,
            params: [100, 0, 0],
        };
        match DeviceEvent::from_container(&container) {
            DeviceEvent::Unknown { code, params } => {
                assert_eq!(code, 0x4006);
                assert_eq!(params[0], 100);
            }
            _ => panic!("Expected Unknown event"),
        }
    }
}