restorekit 0.4.3

Library for DFU-restoring Apple Silicon Macs: DFU trigger, detection, firmware download, and restore
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

use serde::Serialize;

use crate::device::Device;

/// Progress events emitted by long-running library operations.
///
/// The library never prints or prompts; frontends (CLI, GUI) render these.
#[derive(Debug, Clone, Serialize)]
#[serde(tag = "event", rename_all = "snake_case")]
pub enum Event {
    /// A stage of the VDM DFU trigger (host-side USB-PD dance).
    DfuTriggerStage {
        stage: String,
    },
    /// A Mac in DFU mode was detected.
    DeviceDetected {
        device: Device,
    },
    /// Firmware metadata was resolved for the target.
    FirmwareResolved {
        identifier: String,
        version: String,
        build: String,
        size: u64,
        url: String,
    },
    /// The requested firmware is already in the cache.
    CacheHit {
        path: String,
    },
    /// A previous partial download is being resumed.
    DownloadResumed {
        received: u64,
    },
    DownloadProgress {
        received: u64,
        total: u64,
    },
    /// Verifying the downloaded file's checksum.
    Verifying,
    /// A restore step reported by idevicerestore.
    RestoreStep {
        step: u32,
        name: String,
        progress: f32,
    },
    /// One line of idevicerestore's log, streamed live for a log window.
    LogLine {
        level: i32,
        line: String,
    },
    /// A restore attempt failed on a transient transport error (e.g. a dropped
    /// USB write mid-transfer) and is being retried from the top.
    RestoreRetrying {
        /// The attempt that just failed (1-based).
        attempt: u32,
        max_attempts: u32,
        message: String,
    },
    /// The embedded usbmuxd server is starting (Linux only).
    UsbmuxdStarting,
    /// Binding the WinUSB driver to Apple's DFU/recovery devices (Windows only).
    DriverSetupStarting,
    /// WinUSB was bound to a device class (Windows only).
    DriverBound {
        name: String,
    },
    Done,
}

pub type ProgressFn<'a> = &'a mut dyn FnMut(Event);