liblitho 0.2.0

cli tool to flash/clone the images to storage 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

//! Flash/clone dispatch: simulated by default, real block I/O when `real-io` is enabled.
//!
//! - **Default (`simulated-io`)** — safe for development and `cargo test`; no block writes.
//! - **Release (`real-io`)** — `cargo build --no-default-features --features real-io`.

use crate::progress::OperationProgress;
use anyhow::Result;
use std::sync::atomic::AtomicBool;

#[cfg(all(feature = "real-io", feature = "simulated-io"))]
compile_error!("Features `real-io` and `simulated-io` are mutually exclusive. Build real I/O with: cargo build --no-default-features --features real-io");

#[cfg(all(test, feature = "real-io"))]
compile_error!(
    "Do not run tests with `real-io` enabled (risk of accidental disk writes). Use default features: cargo test"
);

#[cfg(not(feature = "real-io"))]
use crate::cli_simulate;

/// True when flash/clone use the simulator instead of `liblitho::flash` / `clone`.
pub const USES_SIMULATED_IO: bool = cfg!(not(feature = "real-io"));

pub fn flash_io<F>(
    image: &str,
    device: &str,
    block_size: usize,
    silent: bool,
    verify: bool,
    progress: Option<F>,
    cancel: Option<&AtomicBool>,
) -> Result<()>
where
    F: FnMut(OperationProgress),
{
    #[cfg(feature = "real-io")]
    {
        crate::flash(image, device, block_size, silent, verify, progress, cancel)
    }

    #[cfg(not(feature = "real-io"))]
    {
        cli_simulate::simulate_flash(image, device, block_size, silent, verify, progress, cancel)
    }
}

pub fn clone_io<F>(
    device: &str,
    file: &str,
    block_size: usize,
    silent: bool,
    progress: Option<F>,
    cancel: Option<&AtomicBool>,
) -> Result<()>
where
    F: FnMut(OperationProgress),
{
    #[cfg(feature = "real-io")]
    {
        crate::clone(device, file, block_size, silent, progress, cancel)
    }

    #[cfg(not(feature = "real-io"))]
    {
        cli_simulate::simulate_clone(device, file, block_size, silent, progress, cancel)
    }
}

pub fn in_progress_suffix() -> &'static str {
    if USES_SIMULATED_IO {
        " (simulation — disk writes disabled)"
    } else {
        ""
    }
}

pub fn complete_suffix() -> &'static str {
    if USES_SIMULATED_IO {
        " (simulation)"
    } else {
        ""
    }
}