Otaripper

https://github.com/syedinsaf/otaripper
Admin
Otaripper is a high-performance tool written in Rust that extracts partitions from Android OTA files...
Tokens:28,502
Snippets:469
Trust Score:7.6
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Output Directory Naming Examples

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Examples of directory naming conventions based on metadata availability.

```text
extracted_20250101_120000_unknown
```

```text
extracted_20250101_120000_Pixel9Pro_AP1A.240705.001
```

```text
extracted_<timestamp>_<product_name>_<version_name>
```

--------------------------------

### JSON Output Format Example

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Example structure of the JSON file generated when the user confirms output creation.

```json
{
  "device_model": "PJZ110",
  "update_label": "PJZ110_16.0.5.701(CN01)_260303",
  "image": "xbl_config.img",
  "major": 3,
  "minor": 0,
  "arb": 1,
  "hash_offset": 8192,
  "hash_size": 256
}
```

--------------------------------

### parse_version_info Input and Output

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Example JSON input and the resulting HashMap structure.

```json
{
  "android_version": "15",
  "security_patch": "2025-01-01",
  "build_fingerprint": "google/Pixel9Pro/Pixel9Pro:15/AP1A.240705.001/12345678:user/release-keys"
}
```

```rust
{
    "android_version": "15",
    "security_patch": "2025-01-01",
    "build_fingerprint": "google/Pixel9Pro/..."
}
```

--------------------------------

### Initialize and run Extractor

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/extractor.md

Example showing how to parse CLI arguments and execute the extraction process.

```rust
use otaripper::cmd::Cmd;
use clap::Parser;

// Parse CLI args
let cmd = Cmd::parse();

// Create extractor and run
let extractor = Extractor { cmd: &cmd };
extractor.run()?;
```

--------------------------------

### parse_properties Input and Output

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Example input properties file and the resulting HashMap structure.

```text
# comment
key1=value1
key2 = value 2
# blank line below

key3=value with = signs
```

```rust
{
    "key1": "value1",
    "key2": "value 2",
    "key3": "value with = signs"
}
```

--------------------------------

### Usage Example for ExtentsWriter

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

Demonstrates initializing the writer with multiple extents and performing a write operation.

```rust
let mut extent1 = vec![0u8; 4096];
let mut extent2 = vec![0u8; 4096];
let mut extents: &mut [&mut [u8]] = &mut [&mut extent1, &mut extent2];

let simd = CpuSimd::get();
let mut writer = ExtentsWriter::new(extents, simd);

// Use as io::Write
writer.write_all(b"hello world")?;
```

--------------------------------

### Retrieve Cached CPU Capability

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

Example usage of the get() method to determine available SIMD acceleration.

```rust
let simd = CpuSimd::get();
match simd {
    CpuSimd::Avx512 => println!("AVX-512 available"),
    CpuSimd::Avx2 => println!("AVX2 available"),
    CpuSimd::Sse2 => println!("SSE2 available"),
    CpuSimd::None => println!("No SIMD acceleration"),
}
```

--------------------------------

### Common CLI Operations

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/README.md

Examples of using the otaripper binary for partition extraction, listing, remote streaming, and bootloader analysis.

```bash
# Extract all partitions
otaripper update.zip

# Extract specific partitions
otaripper update.zip -p boot,init_boot

# List partitions
otaripper -l update.zip

# Stream from remote URL
otaripper https://example.com/ota.zip -p boot

# Analyze bootloader
otaripper arbscan xbl_config.img
```

--------------------------------

### version_info.txt JSON Format

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Example of the JSON structure used in version_info.txt files, typically found in EDL firmware packages.

```json
{
  "android_version": "15",
  "pre-device": "Pixel9Pro",
  "version_name": "AP1A.240705.001",
  "build_version": "A14B1.240805"
}
```

--------------------------------

### Install otaripper on Arch Linux

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Commands to install otaripper using AUR helpers like paru or yay.

```bash
paru -S otaripper        # build from source (recommended)
paru -S otaripper-bin    # prebuilt glibc binary

yay -S otaripper
yay -S otaripper-bin
```

--------------------------------

### Log CPU Detection Results

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

Example output when the OTARIPPER_DEBUG_CPU environment variable is set to 1.

```text
CPU Feature Detection:
  AVX512F: true
  AVX512BW: true
  AVX2: true
  SSE2: true
  Selected: Avx512
```

--------------------------------

### Install and update otaripper via winget

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Use these commands to install or update the otaripper package on Windows systems.

```powershell
winget install syedinsaf.otaripper
```

```powershell
winget update syedinsaf.otaripper
# or
winget upgrade syedinsaf.otaripper
```

--------------------------------

### payload_properties.txt Properties Format

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Example of the key-value property format used in payload_properties.txt files.

```properties
FILE_HASH=abc123...
FILE_SIZE=3000000000
METADATA_HASH=def456...
METADATA_SIZE=12345
```

--------------------------------

### Integrate Otaripper as a library

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/INDEX.md

Basic setup for using the Otaripper command parser within a Rust application.

```rust
use otaripper::cmd::Cmd;
use clap::Parser;

let cmd = Cmd::parse();
cmd.run()?;
```

--------------------------------

### META-INF/com/android/metadata Properties Format

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Example of the standard Android OTA metadata properties file format.

```properties
post-build=Pixel9Pro.AP1A.240705.001
post-device=Pixel9Pro
post-timestamp=1722816000
post-build-fingerprint=google/Pixel9Pro/Pixel9Pro:15/AP1A.240705.001/12345678:user/release-keys
```

--------------------------------

### View otaripper version

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/README.md

Command to check the currently installed version of the otaripper CLI tool.

```bash
otaripper --version
```

--------------------------------

### Remote ARB inspection

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Example output of inspecting ARB metadata from a remote URL.

```text
$ otaripper arb https://example.com/firmware.zip
[arbscan] Connecting to remote server...
[arbscan] EDL firmware zip detected. Scanning for bootloader image...
[arbscan] Found candidate: RADIO/xbl_config.img. Extracting temporarily...
[arbscan] Analyzing: extracted_bootloader.img

OEM Metadata
────────────
  Major Version : 3
  Minor Version : 0
  ARB Index     : 1

Write JSON output? [y/N]: y
Device model      : PJZ110
Update / build    : PJZ110_16.0.5.701(CN01)_260303

✔ JSON written: PJZ110_PJZ110_16.0.5.701(CN01)_260303_ARB(1).json
```

--------------------------------

### Partition filter validation error

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Example of an error triggered when a specified partition is missing from the OTA manifest.

```bash
otaripper update.zip -p boot,nonexistent
```

```text
partition "nonexistent" not found in manifest
```

--------------------------------

### Thread count validation error

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Example of an error triggered when the thread count exceeds the allowed range of 1–256.

```bash
otaripper update.zip -t 1000
```

```text
Thread count 1000 is out of range.
Valid range: 1–256
```

--------------------------------

### Initialize and Run Extraction as a Library

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/README.md

Demonstrates how to parse CLI arguments and execute the extraction process programmatically using the otaripper crate.

```rust
use otaripper::cmd::Cmd;
use clap::Parser;

// Parse CLI arguments
let cmd = Cmd::parse();

// Run extraction
cmd.run()?;
```

--------------------------------

### Integrate as a Library

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Demonstrates parsing CLI arguments or manual configuration to trigger extraction.

```rust
use otaripper::cmd::Cmd;
use otaripper::payload::Payload;
use clap::Parser;
use std::fs;

// Parse CLI args
let cmd = Cmd::parse();

// Or construct manually
let cmd = Cmd {
    subcmd: None,
    list: false,
    threads: Some(4),
    output_dir: None,
    partitions: vec!["boot".to_string()],
    no_verify: false,
    strict: true,
    print_hash: true,
    sanity: true,
    stats: true,
    no_open: true,
    positional_payload: Some("update.zip".into()),
    quiet: false,
};

// Run extraction
cmd.run()?;
```

--------------------------------

### Build otaripper from Source

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Commands to clone the repository and perform various build configurations using Cargo.

```bash
# Clone
git clone https://github.com/syedinsaf/otaripper.git
cd otaripper

# Full build (standard release)
cargo full

# Lite build (no remote)
cargo lite

# Custom build (no default features)
cargo build --release --no-default-features
```

--------------------------------

### Build otaripper on Windows

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Execute the PowerShell script to compile a native release binary on Windows.

```powershell
.\build.ps1
```

--------------------------------

### Perform Remote Extraction in Rust

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Demonstrates initializing the command parser and the remote extraction workflow using HTTP range requests.

```rust
use otaripper::cmd::Cmd;
use otaripper::payload::Payload;
use otaripper::remote::fetch_http_chunk;
use clap::Parser;

// Parse CLI arguments
let args = vec!["otaripper", "https://example.com/ota.zip", "-p", "boot"];
let cmd = Cmd::parse_from(args);

// The extractor will:
// 1. Create a CachingHttpReader for the remote ZIP
// 2. Stream the 256 KB header to detect it's a ZIP and locate payload.bin
// 3. Parse payload header and manifest via HTTP Range requests
// 4. For each requested partition, fetch only required byte ranges via fetch_http_chunk()
// 5. Decompress and verify locally
```

--------------------------------

### CLI Entry Point

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Main function implementation for the CLI interface.

```rust
// src/main.rs
fn main() {
    if let Err(e) = Cmd::parse().run() {
        eprintln!("\nERROR: {:#}", e);
        std::process::exit(1);
    }
}
```

--------------------------------

### Fetch and display firmware metadata in Rust

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Retrieves metadata from a specified zip file and prints device information if available.

```rust
use otaripper::cmd::metadata;

let metadata = metadata::fetch_metadata("update.zip");
if let Some(ref meta) = metadata {
    println!("Firmware Information");
    println!("────────────────────");
    if let Some(model) = meta.get("product_name") {
        println!("Device Model: {}", model);
    }
    if let Some(version) = meta.get("android_version") {
        println!("Android Version: {}", version);
    }
}
```

--------------------------------

### Build otaripper on Linux/macOS

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Execute the build script to compile a native release binary for Unix-based systems.

```bash
chmod +x build.sh
./build.sh
```

--------------------------------

### Build otaripper with Cargo

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Commands to build the project with or without remote streaming support.

```bash
# Full build (includes remote)
cargo build --release

# Lite build (local extraction only)
cargo build --release --no-default-features
```

--------------------------------

### Define InstallOperation Protobuf Structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/types.md

Represents a single update operation such as REPLACE, ZERO, or DISCARD.

```rust
pub struct InstallOperation {
    pub r#type: i32,  // install_operation::Type enum
    pub data_offset: Option<u64>,
    pub data_length: Option<u64>,
    pub src_extents: Vec<Extent>,
    pub src_length: Option<u64>,
    pub dst_extents: Vec<Extent>,
    pub dst_length: Option<u64>,
    pub data_sha256_hash: Option<Vec<u8>>,
    // ... more fields
}
```

--------------------------------

### Initialize ExtentsWriter

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

Signature for creating a new instance of the writer.

```rust
pub(crate) fn new(extents: &'a mut [&'b mut [u8]], simd: CpuSimd) -> Self
```

--------------------------------

### Locate Linux/macOS Output Binary

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Path to the generated binary after running the build script.

```text
~/otaripper-native/otaripper
```

--------------------------------

### List Partitions

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Lists the contents of the OTA update file without extracting them.

```bash
otaripper -l update.zip
```

--------------------------------

### Verification and configuration flags

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Additional flags for hashing, strict verification, and controlling folder behavior.

```bash
otaripper ota.zip --print-hash
```

```bash
otaripper ota.zip --strict
```

```bash
otaripper ota.zip -n
```

--------------------------------

### Execute Cmd run method

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/cmd.md

Executes the parsed command logic.

```rust
pub fn run(&self) -> Result<()>
```

```rust
use otaripper::cmd::Cmd;
use clap::Parser;

let args = std::env::args();
let cmd = Cmd::parse_from(args);
cmd.run()?;
```

--------------------------------

### Define PartitionInfo Protobuf Structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/types.md

Contains metadata including partition size and SHA-256 hash.

```rust
pub struct PartitionInfo {
    pub size: Option<u64>,
    pub hash: Option<Vec<u8>>,
}
```

--------------------------------

### Build with Remote Features

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Commands to build the project with or without the default remote streaming feature enabled.

```bash
# Standard build (includes remote)
cargo build --release

# Lite build (no remote)
cargo build --release --no-default-features
```

--------------------------------

### Execute ARB Metadata Extraction in Rust

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

The run function serves as the primary entry point for analyzing bootloader images. It requires a path to the target file and a boolean flag to control JSON output behavior.

```rust
use otaripper::cmd::arbscan;
use std::path::PathBuf;

arbscan::run(false, &PathBuf::from("xbl_config.img"))?;
// Output: Displays ARB metadata and prompts for JSON
```

--------------------------------

### Cmd::run

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Executes the extraction process based on the configured command parameters.

```APIDOC
## Cmd::run()

### Description
Executes the extraction logic defined by the Cmd configuration, including partition extraction and verification.

### Parameters
- **self** (Cmd) - Required - The configured command instance containing partitions, output directory, and processing flags.
```

--------------------------------

### Extract firmware metadata from various sources

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Demonstrates usage of fetch_metadata with local files, remote URLs, and directories. Remote URL extraction requires the 'remote' feature to be enabled.

```rust
use otaripper::cmd::metadata;
use std::collections::HashMap;

// From local file
if let Some(meta) = metadata::fetch_metadata("update.zip") {
    println!("Device: {}", meta.get("product_name").unwrap_or(&"Unknown".to_string()));
    println!("Android: {}", meta.get("android_version").unwrap_or(&"Unknown".to_string()));
}

// From remote URL (requires "remote" feature)
if let Some(meta) = metadata::fetch_metadata("https://example.com/ota.zip") {
    println!("Remote device model: {}", meta.get("pre-device").unwrap_or(&"Unknown".to_string()));
}

// From directory
if let Some(meta) = metadata::fetch_metadata("/extracted_firmware/") {
    println!("Directory metadata: {:?}", meta);
}
```

--------------------------------

### Partition File Creation Failure Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the application cannot open or create a partition file.

```text
failed to open partition file: [OS error details]
```

--------------------------------

### fetch_metadata(path_str: &str)

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Attempts to extract firmware metadata from a local file, remote URL, or directory. Returns a HashMap of key-value pairs containing the metadata or None if extraction fails.

```APIDOC
## fetch_metadata(path_str: &str)

### Description
Attempts to extract firmware metadata from a local file, remote URL, or directory. It supports ZIP files, specific metadata text files, and remote OTA URLs.

### Signature
`pub fn fetch_metadata(path_str: &str) -> Option<HashMap<String, String>>`

### Parameters
- **path_str** (&str) - Required - File path (.zip, payload.bin), HTTP(S) URL, or directory path.

### Returns
- **Option<HashMap<String, String>>** - Parsed metadata key-value pairs or None if not found.

### Example
```rust
use otaripper::cmd::metadata;

// From local file
if let Some(meta) = metadata::fetch_metadata("update.zip") {
    println!("Device: {}", meta.get("product_name").unwrap_or(&"Unknown".to_string()));
}
```
```

--------------------------------

### Compare Traditional I/O vs otaripper Memory Mapping

Source: https://github.com/syedinsaf/otaripper/blob/main/TECHNICAL.md

Visual representation of the I/O path difference between traditional buffered reading and direct memory mapping.

```text
Traditional:
  File → read() → Kernel Buffer → User Buffer → Copy → Process

otaripper:
  File → mmap() → Direct Process Access
```

--------------------------------

### Analyze OTA ZIP

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Automatically searches for bootloader candidates within an OTA ZIP archive.

```bash
otaripper arbscan firmware.zip

# otaripper automatically searches for bootloader candidate
# (typically named xbl_config.*, xbl.*, boot.*, etc.)
```

--------------------------------

### Basic Local Parsing

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/payload.md

Demonstrates loading a payload from a local file or extracting it from a ZIP archive before parsing.

```rust
use otaripper::payload::Payload;
use std::fs;

// Load from disk
let data = fs::read("update.zip")?;

// Or extract payload.bin from ZIP
let mut zip = zip::ZipArchive::new(std::io::Cursor::new(&data))?;
let mut payload_file = zip.by_name("payload.bin")?;
let mut payload_data = Vec::new();
payload_file.read_to_end(&mut payload_data)?;

// Parse
let payload = Payload::parse(&payload_data)?;
println!("Version: {}", payload.file_format_version);
```

--------------------------------

### Analyze EDL Directory

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Performs a recursive search for bootloader images within a specified directory.

```bash
otaripper arbscan CPH2583_EDL_Folder/

# Searches directory recursively for bootloader images
```

--------------------------------

### Project Directory Structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/README.md

Visual representation of the project file hierarchy.

```text
├── API.md                          ← Start here
├── README.md                       ← This file
├── configuration.md                ← Command-line options
├── types.md                        ← Type reference
├── errors.md                       ← Error catalog
└── api-reference/
    ├── cmd.md                      ← CLI & argument parsing
    ├── payload.md                  ← OTA format & parsing
    ├── extractor.md                ← Core extraction
    ├── simd.md                     ← SIMD acceleration
    ├── remote.md                   ← HTTP streaming
    ├── arbscan.md                  ← ARB metadata
    └── metadata.md                 ← Device info
```

--------------------------------

### Define run method

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/extractor.md

The run method serves as the main entry point for the extraction workflow.

```rust
pub fn run(&self) -> Result<()>
```

--------------------------------

### arbscan::run

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

The primary entry point for extracting and analyzing ARB metadata from bootloader images or firmware packages.

```APIDOC
## arbscan::run

### Description
Main entry point for ARB metadata extraction and analysis. It detects the input type, locates the ELF section containing ARB metadata, parses the struct, and outputs the results.

### Signature
`pub fn run(no_json: bool, image: &PathBuf) -> Result<()>`

### Parameters
- **no_json** (bool) - Required - If true, skip interactive JSON output prompt.
- **image** (&PathBuf) - Required - Path to bootloader image (.img, .elf), OTA .zip, or EDL firmware directory.

### Returns
- **Result<()>** - Returns success or a detailed error if the extraction or parsing fails.

### Example
```rust
use otaripper::cmd::arbscan;
use std::path::PathBuf;

arbscan::run(false, &PathBuf::from("xbl_config.img"))?;
```
```

--------------------------------

### Execute CLI Commands

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Common command-line operations for extracting and analyzing OTA packages.

```bash
# Extract all partitions
otaripper update.zip

# List partitions
otaripper -l update.zip

# Extract specific partitions with stats
otaripper update.zip -p boot,init_boot --stats

# Remote extraction (feature: remote)
otaripper https://example.com/ota.zip -p boot

# Analyze bootloader
otaripper arbscan xbl_config.img
```

--------------------------------

### Perform Pre-Flash ARB Analysis

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Use this command to check the ARB index of a new bootloader image before flashing to prevent device bricking.

```bash
otaripper arbscan new_bootloader.img
# Check ARB index matches or exceeds current device ARB
```

--------------------------------

### Execute Otaripper CLI commands

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/INDEX.md

Common CLI patterns for extracting partitions, listing contents, and analyzing ARB metadata from local or remote OTA files.

```bash
otaripper update.zip                          # Extract all
otaripper -l update.zip                       # List partitions
otaripper update.zip -p boot,init_boot        # Extract specific
otaripper https://example.com/ota.zip         # Remote stream
otaripper arbscan xbl_config.img              # Analyze ARB
```

--------------------------------

### Check device model from metadata in Rust

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Extracts the product name from metadata and performs pattern matching to identify the device model.

```rust
if let Some(meta) = metadata::fetch_metadata("ota.zip") {
    let model = meta.get("product_name").map(|s| s.as_str()).unwrap_or("Unknown");
    match model {
        "Pixel9Pro" => println!("Pixel 9 Pro detected"),
        "Pixel9" => println!("Pixel 9 detected"),
        _ => println!("Unknown device: {}", model),
    }
}
```

--------------------------------

### Print Hashes

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Computes and displays the SHA-256 hash for each extracted partition.

```bash
otaripper update.zip --print-hash
```

--------------------------------

### Configure Release Profile Optimizations

Source: https://github.com/syedinsaf/otaripper/blob/main/TECHNICAL.md

Apply these settings in Cargo.toml to enable link-time optimization and single-unit codegen for improved performance.

```toml
[profile.release]
lto = "fat"
codegen-units = 1
```

--------------------------------

### Execute Arbscan subcommand

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/cmd.md

Extracts Qualcomm Anti-Rollback metadata from images or remote URLs.

```bash
otaripper arbscan xbl_config.img
otaripper arb https://example.com/firmware.zip  // Remote streaming supported
```

--------------------------------

### Remote Metadata Extraction CLI Usage

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Command to display firmware info without downloading the full OTA.

```bash
otaripper https://example.com/ota.zip -l
```

--------------------------------

### Analyze Qualcomm ARB metadata

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Inspect Anti-Rollback metadata from local files or directories.

```bash
otaripper arb update.zip
# or directories
otaripper arb CPH2583_EDL_Folder/
```

--------------------------------

### Build Otaripper without remote support

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Use this command to create a smaller binary by disabling remote streaming features.

```bash
cargo build --release --no-default-features
```

--------------------------------

### Locate Windows Output Binary

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Path to the generated binary after running the PowerShell build script.

```text
otaripper-native\otaripper.exe
```

--------------------------------

### Bandwidth Usage Comparison

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Comparison of data transfer requirements between traditional full downloads and otaripper remote streaming.

```text
Downloaded: 3 GB
Time: ~2 minutes (at 25 MB/s)
```

```text
Downloaded: 1 GB + 1 MB (headers/metadata)
Time: ~40 seconds
Savings: 2 GB (66% less bandwidth)
```

--------------------------------

### Visualize otaripper Memory Layout

Source: https://github.com/syedinsaf/otaripper/blob/main/TECHNICAL.md

Diagram showing the flow from read-only input mapping through worker threads to write-only output mapping.

```text
┌─────────────────────────────────────┐
│ Input: payload.bin (read-only mmap) │
│ - Shared across all workers         │
│ - OS-managed paging                │
└─────────────────────────────────────┘
                ↓
┌─────────────────────────────────────┐
│ Worker Threads (N parallel)         │
│ - Disjoint extents only             │
│ - No locks in hot path              │
│ - Thread-local decompression        │
│ - 1 MiB thread-local buffer pool    │
└─────────────────────────────────────┘
                ↓
┌─────────────────────────────────────┐
│ Output: partition.img (write mmap)  │
│ - Pre-sized to final length         │
│ - No overlapping writes             │
└─────────────────────────────────────┘
```

--------------------------------

### Output Directory Creation Failure Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the application fails to create the required output directory.

```text
failed to create output directory: [OS error details]
```

--------------------------------

### Enable CPU Debugging

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Set the OTARIPPER_DEBUG_CPU environment variable to output SIMD capability detection results to stderr.

```bash
OTARIPPER_DEBUG_CPU=1 otaripper update.zip
```

--------------------------------

### Partition Not Found Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the partition name provided via the -p flag does not exist in the manifest.

```text
partition "PARTITION_NAME" not found in manifest
```

--------------------------------

### Print Statistics

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Displays performance metrics including throughput and total extraction time.

```bash
otaripper update.zip --stats
```

--------------------------------

### Extract All Partitions

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Extracts all partitions from the specified OTA update file.

```bash
otaripper update.zip
```

--------------------------------

### Verify File Integrity

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Check the SHA256 checksum of the OTA file against the official source.

```bash
sha256sum update.zip
# Compare against checksum published by OEM
```

--------------------------------

### Debug CPU Detection

Source: https://github.com/syedinsaf/otaripper/blob/main/TECHNICAL.md

Use this environment variable to output detected SIMD capabilities and the selected execution path during runtime.

```bash
OTARIPPER_DEBUG_CPU=1 ./otaripper ota.zip
```

--------------------------------

### Firmware Information Banner Format

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

The visual representation of firmware metadata when successfully parsed from the source.

```text
Firmware Information
────────────────────
Product Model                 : Pixel9Pro
Android Version               : 15
Build Version                 : AP1A.240705.001
Security Patch                : 2025-01-01
```

--------------------------------

### Combined Options

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Executes multiple operations simultaneously, including specific partition extraction, custom output, statistics, and hash printing.

```bash
otaripper update.zip -p boot,init_boot -o /tmp/extracted --stats --print-hash -n
```

--------------------------------

### Analyze Local Bootloader Image

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Scans a specific local bootloader image file for ARB metadata.

```bash
otaripper arbscan xbl_config.img

# Output:
# OEM Metadata
# ────────────
#   Major Version : 3
#   Minor Version : 0
#   ARB Index     : 1
#
# Write JSON output? [y/N]:
```

--------------------------------

### Extract OTA packages

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Commands for extracting contents from OTA zip files.

```bash
otaripper ota.zip
```

```bash
otaripper -l ota.zip
```

```bash
otaripper ota.zip -p boot,vendor_boot,init_boot
```

--------------------------------

### CachingHttpReader Usage

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Demonstrates initializing and using the CachingHttpReader to perform Read and Seek operations on a remote file.

```rust
use otaripper::remote::CachingHttpReader;

let client = reqwest::blocking::Client::new();
let mut reader = CachingHttpReader::new(
    client,
    "https://example.com/ota.zip",
    &progress_bar
)?;

// Use as normal Read + Seek
let mut buf = [0u8; 1024];
reader.read_exact(&mut buf)?;
reader.seek(std::io::SeekFrom::End(-4096))?;
```

--------------------------------

### Copy data with SIMD acceleration

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

Uses optimal SIMD implementation based on buffer size and CPU capabilities. Requires a CpuSimd instance and destination buffer of equal size to source.

```rust
#[inline]
pub(crate) fn simd_copy_large(simd: CpuSimd, src: &[u8], dst: &mut [u8])
```

```rust
let simd = CpuSimd::get();
let mut dst = vec![0u8; 1_000_000];
simd_copy_large(simd, &src_data, &mut dst);
```

--------------------------------

### Initialize thread-local copy buffer

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/extractor.md

Allocates a 1 MB reusable buffer per Rayon worker thread to reduce allocation overhead during REPLACE operations.

```rust
thread_local! {
    static COPY_BUFFER: RefCell<Vec<u8>> = RefCell::new(vec![0; 1024 * 1024]);
}
```

--------------------------------

### Enable Strict Mode

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Enforces mandatory verification and hash checks for all partitions and operations. Recommended for production environments.

```bash
otaripper --strict update.zip
```

--------------------------------

### Verify binary integrity using sha256sum

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Execute this command in the terminal after extracting the release archive to verify the integrity of the binaries.

```bash
sha256sum -c *.sha256
```

--------------------------------

### Verify Security Compliance

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Filter the ARB index output to enforce minimum version requirements for security compliance.

```bash
otaripper arbscan xbl_config.img | grep "ARB Index"
# Fail if index < 5 (example compliance requirement)
```

--------------------------------

### Define Cmd struct

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/cmd.md

The root structure for command-line argument parsing.

```rust
pub struct Cmd {
    pub(super) subcmd: Option<SubCmd>,
    pub(super) list: bool,
    pub(super) threads: Option<usize>,
    pub(super) output_dir: Option<PathBuf>,
    pub(super) partitions: Vec<String>,
    pub(super) no_verify: bool,
    pub(super) strict: bool,
    pub(super) print_hash: bool,
    pub(super) sanity: bool,
    pub(super) stats: bool,
    pub(super) no_open: bool,
    pub(super) positional_payload: Option<PathBuf>,
    pub(super) quiet: bool,
}
```

--------------------------------

### Define fetch_metadata function signature

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

The function signature for extracting firmware metadata from a given path string.

```rust
pub fn fetch_metadata(path_str: &str) -> Option<HashMap<String, String>>
```

--------------------------------

### Audit Firmware Repository for ARB Levels

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Iterate through a directory of firmware files to extract and display ARB information for each.

```bash
for file in firmware/*.zip; do
    echo "=== $file ==="
    otaripper arb "$file" -n
done
```

--------------------------------

### Unsupported OTA Version Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the OTA file format version is greater than 2.

```text
This update uses a newer format than this version of otaripper supports. 
Please check for an app update!
```

--------------------------------

### Define DeltaArchiveManifest Protobuf Structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/types.md

The top-level manifest structure decoded from the OTA payload.

```rust
pub struct DeltaArchiveManifest {
    pub version: Option<u64>,
    pub block_size: Option<u32>,
    pub partial_update: Option<bool>,
    pub partitions: Vec<PartitionUpdate>,
    pub max_timestamp: Option<i64>,
    pub signatures: Option<Signatures>,
}
```

--------------------------------

### Cleanup Refused on Root Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed as a safety mechanism when attempting to clean the filesystem root.

```text
Refusing to clean filesystem root.
```

--------------------------------

### Execute Clean subcommand

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/cmd.md

Removes previously extracted folders.

```bash
otaripper clean -o /path/to/output
```

--------------------------------

### Run Sanity Checks

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Detects structural anomalies and invalid output such as zero-filled partitions.

```bash
otaripper --sanity update.zip
```

--------------------------------

### Remote ARB Analysis

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Streams a bootloader image header from a remote URL to extract metadata without downloading the full file.

```bash
otaripper arbscan https://example.com/firmware.zip

# Streams bootloader image header over HTTP
# Extracts only the necessary bytes (typically < 100 MB)
# No need to download entire 3+ GB zip
```

--------------------------------

### Unknown File Type Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the provided file format is not recognized.

```text
❌ This file isn't a recognized Android update.

👉 Valid inputs:
  - A raw 'payload.bin' file
  - A full OTA .zip (with payload.bin inside)

💡 Tip: Just drag the correct file onto otaripper! 😎
```

--------------------------------

### Extract with Custom Output Directory

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Specifies a target directory for the extracted partition files.

```bash
otaripper update.zip -o /mnt/extracted
```

--------------------------------

### metadata::fetch_metadata

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Retrieves metadata from a specified OTA update file path. Returns an Option containing a map of firmware attributes.

```APIDOC
## metadata::fetch_metadata(path: &str)

### Description
Fetches firmware metadata from a provided file path (e.g., a .zip file). The function returns an Option containing the metadata map if successful.

### Signature
`pub fn fetch_metadata(path: &str) -> Option<HashMap<String, String>>`

### Parameters
- **path** (str) - Required - The file path to the OTA update package.

### Returns
- **Option<HashMap<String, String>>** - Returns the metadata map if the file is valid and contains metadata, otherwise returns None.
```

--------------------------------

### Run Sanity Checks

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Performs validation to detect obviously invalid output, such as all-zero partitions.

```bash
otaripper update.zip --sanity
```

--------------------------------

### Incomplete File Header Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when a version 2 file is too small to contain a valid header.

```text
The file header is incomplete. This usually happens with a broken download.
```

--------------------------------

### Missing ARB Metadata Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when ARB metadata is missing or unreadable in the bootloader.

```text
Metadata error: ARB metadata not found or unreadable
```

--------------------------------

### Invalid ELF Header Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the bootloader image is not in a valid ELF format.

```text
Invalid ELF: [specific reason]
```

--------------------------------

### File Too Small Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the input file is less than 20 bytes.

```text
This file is too small to be an Android update. Please check your download.
```

--------------------------------

### Library Module Structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Public module exports for the library interface.

```rust
// src/lib.rs
pub mod cmd;
pub mod payload;
pub mod proto;
#[cfg(feature = "remote")]
pub mod remote;
```

--------------------------------

### Define Public API in lib.rs

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Exposes core modules for library consumers.

```rust
pub mod cmd;              // Cmd, SubCmd
pub mod payload;          // Payload, PayloadData
pub mod proto;            // DeltaArchiveManifest, etc.
#[cfg(feature = "remote")]
pub mod remote;           // fetch_http_chunk, etc.
```

--------------------------------

### Define PartitionUpdate Protobuf Structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/types.md

Aggregates all operations required for a single partition update.

```rust
pub struct PartitionUpdate {
    pub partition_name: String,
    pub run_postinstall: Option<bool>,
    pub postinstall_path: Option<String>,
    pub filesystem_type: Option<String>,
    pub new_partition_info: Option<PartitionInfo>,
    pub operations: Vec<InstallOperation>,
}
```

--------------------------------

### Arbscan Subcommand Usage

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Extracts and displays Qualcomm Anti-Rollback metadata from bootloader images. Global extraction flags are not applicable to this subcommand.

```bash
otaripper arbscan [OPTIONS] <PATH>
otaripper arb [OPTIONS] <PATH>
```

--------------------------------

### fetch_http_chunk

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Fetches a single partition chunk from a remote HTTP URL with optional parallel sub-chunking and progress reporting.

```APIDOC
## fetch_http_chunk

### Description
Fetches a single partition chunk from a remote HTTP URL. It supports parallel range requests for chunks larger than 8 MB and provides progress reporting.

### Signature
`pub fn fetch_http_chunk(client: &reqwest::blocking::Client, url: &str, start: u64, size: usize, pb: &ProgressBar, total_dst_size: usize) -> anyhow::Result<Vec<u8>>`

### Parameters
- **client** (&reqwest::blocking::Client) - Required - Pre-configured HTTP client.
- **url** (&str) - Required - HTTP(S) URL to remote OTA file.
- **start** (u64) - Required - Byte offset in remote file to start reading.
- **size** (usize) - Required - Number of bytes to fetch.
- **pb** (&ProgressBar) - Required - Progress bar for UI feedback.
- **total_dst_size** (usize) - Required - Total output partition size for ratio-based progress reporting.

### Returns
- **Result** (anyhow::Result<Vec<u8>>) - Downloaded chunk or error.
```

--------------------------------

### Set Network Online

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Resets the global progress bar to display ETA and bandwidth information.

```rust
pub fn set_network_online()
```

```rust
set_network_online();
```

--------------------------------

### Missing Partition Hash Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Occurs in --strict mode when a partition is missing its corresponding hash in the manifest.

```text
strict mode: missing partition hash for 'PARTITION_NAME'
```

--------------------------------

### SSE2 SIMD copy implementation

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

128-bit copy operation used as a fallback for older CPUs.

```rust
#[target_feature(enable = "sse2")]
unsafe fn simd_copy_sse2(src: &[u8], dst: &mut [u8])
```

--------------------------------

### Strict Verification

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Enforces manifest hash verification for all extracted partitions.

```bash
otaripper update.zip --strict
```

--------------------------------

### Configure Remote Feature via Cargo

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Controls the inclusion of HTTP(S) streaming support during the build process.

```bash
cargo build --release                      # includes remote
cargo build --release --no-default-features # exclude remote
```

--------------------------------

### Define GLOBAL_NETWORK_STATUS progress bar

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Thread-safe global progress bar container for tracking network download status.

```rust
pub static GLOBAL_NETWORK_STATUS: OnceLock<ProgressBar> = OnceLock::new();
```

--------------------------------

### Analyze Bootloader ARB

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Scans bootloader images or remote firmware for Anti-Rollback (ARB) metadata.

```bash
otaripper arbscan xbl_config.img
```

```bash
otaripper arb https://example.com/firmware.zip
```

--------------------------------

### Documentation Navigation Map

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/README.md

Visual representation of the documentation hierarchy and cross-references.

```text
API.md (start here)
  ├─→ api-reference/cmd.md
  ├─→ api-reference/payload.md
  ├─→ api-reference/extractor.md
  ├─→ api-reference/simd.md
  ├─→ api-reference/remote.md
  ├─→ api-reference/arbscan.md
  ├─→ api-reference/metadata.md
  ├─→ types.md
  ├─→ configuration.md
  └─→ errors.md
```

--------------------------------

### AVX2 SIMD copy implementations

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

256-bit copy operations for AVX2-capable CPUs.

```rust
#[target_feature(enable = "avx2")]
unsafe fn simd_copy_avx2(src: &[u8], dst: &mut [u8])
```

```rust
#[target_feature(enable = "avx2")]
unsafe fn simd_copy_avx2_stream(src: &[u8], dst: &mut [u8])
```

--------------------------------

### Detect zero-filled buffers with SIMD

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

Checks if all bytes in a buffer are zero using SIMD instructions for improved performance over scalar iteration.

```rust
#[inline(always)]
pub(crate) fn is_all_zero_with_simd(simd: CpuSimd, data: &[u8]) -> bool
```

```rust
let simd = CpuSimd::get();
let zeros = vec![0u8; 1_000_000];
assert!(is_all_zero_with_simd(simd, &zeros));
```

--------------------------------

### Define Extent Protobuf Structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/types.md

Represents a contiguous block range within a partition.

```rust
pub struct Extent {
    pub start_block: Option<u64>,
    pub num_blocks: Option<u64>,
}
```

--------------------------------

### Partition Hash Mismatch Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Indicates that the computed partition hash does not match the manifest hash during verification.

```text
hash mismatch for partition 'PARTITION_NAME': 
expected SHA256(HASH), got SHA256(COMPUTED_HASH)
```

--------------------------------

### Parse Low-Level Payloads

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Directly parse binary payload files and decode the associated protobuf manifest.

```rust
use otaripper::payload::Payload;
use std::fs;

let data = fs::read("payload.bin")?;
let payload = Payload::parse(&data)?;

println!("Version: {}", payload.file_format_version);
println!("Manifest size: {}", payload.manifest_size);

// Decode manifest protobuf
use prost::Message;
let manifest = otaripper::proto::chromeos_update_engine::DeltaArchiveManifest::decode(
    payload.manifest
)?;

for partition in &manifest.partitions {
    println!("Partition: {}", partition.partition_name);
}
```

--------------------------------

### Remote HTTP Streaming

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Extracts partitions directly from a remote URL, avoiding a full download.

```bash
otaripper https://android.googleapis.com/packages/ota-api/package.zip -p boot,init_boot
```

--------------------------------

### Define CleanupState structure

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/extractor.md

Used to track files and directories for automatic cleanup during failures or interruptions.

```rust
struct CleanupState {
    files: Vec<PathBuf>,
    dir: PathBuf,
    dir_is_new: bool,
}
```

--------------------------------

### Define SubCmd enum

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/cmd.md

Enumeration of available subcommands for the CLI.

```rust
pub enum SubCmd {
    Clean {
        output_dir: Option<PathBuf>,
    },
    Arbscan {
        no_json: bool,
        image: PathBuf,
    },
}
```

--------------------------------

### Payload::parse()

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/payload.md

Parses a raw payload binary from a local byte slice.

```APIDOC
## Payload::parse()

### Description
Parses a raw payload binary (typically from a .zip or raw payload.bin). It validates the magic bytes, format version, and metadata sizes.

### Signature
`pub fn parse(bytes: &'a [u8]) -> Result<Self>`

### Parameters
- **bytes** (&[u8]) - Required - Raw payload binary data (minimum 20 bytes for v1, 24 for v2)

### Returns
- **Result<Self>** - Parsed payload or detailed error

### Example
```rust
use otaripper::payload::Payload;
use anyhow::Result;
use std::fs;

let raw_data = fs::read("payload.bin")?;
let payload = Payload::parse(&raw_data)?;

println!("Version: {}", payload.file_format_version);
```
```

--------------------------------

### Define Stat for Extraction Statistics

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/types.md

Internal structure for tracking per-partition timing and throughput metrics.

```rust
#[derive(Clone)]
struct Stat {
    name: String,
    bytes: u64,
    ms: u128,
}
```

--------------------------------

### set_network_online

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Resets the global progress bar to an online state.

```APIDOC
## set_network_online

### Description
Resets global progress bar to online state (shows ETA and bandwidth).

### Signature
`pub fn set_network_online()`
```

--------------------------------

### Error Handling Pattern

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/API.md

Standard pattern for displaying errors from API calls.

```rust
if let Err(e) = cmd.run() {
    eprintln!("\nERROR: {:#}", e);
    // Display includes full error chain
}
```

--------------------------------

### Detect CPU Features

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/simd.md

Function signature for detecting CPU features using the is_x86_feature_detected! macro.

```rust
fn detect() -> Self
```

--------------------------------

### Extract Specific Partitions

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/configuration.md

Extracts only the partitions specified in the comma-separated list.

```bash
otaripper update.zip -p boot,init_boot,vendor_boot
```

--------------------------------

### Manifest Decode Failure Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Error message displayed when manifest bytes fail protobuf validation.

```text
unable to parse manifest
```

--------------------------------

### Parallel Extraction Workflow

Source: https://github.com/syedinsaf/otaripper/blob/main/TECHNICAL.md

Visual representation of the main thread and worker thread responsibilities during parallel extraction.

```text
Main Thread:
  Parse → Validate → mmap → Spawn workers

Worker:
  Read → Decompress → Write → Progress update
```

--------------------------------

### File I/O Error Messages

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Error messages returned when the system encounters issues accessing the target file.

```text
I/O error: Permission denied
I/O error: File not found
```

--------------------------------

### Memory Overflow Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when calculated file offsets exceed memory limits.

```text
Memory overflow: This update file is abnormally large.
```

--------------------------------

### Missing Operation Hash Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Occurs in --strict mode when an operation lacks the required data_sha256_hash.

```text
strict mode: missing data_sha256_hash for an operation in 'PARTITION_NAME'
```

--------------------------------

### parse_version_info Function Signature

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/metadata.md

Signature for the function that parses JSON-formatted metadata.

```rust
fn parse_version_info(content: &str, map: &mut HashMap<String, String>)
```

--------------------------------

### Fetch HTTP Chunk

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/remote.md

Downloads a specific byte range from a remote URL, supporting parallel requests for chunks larger than 8 MB.

```rust
pub fn fetch_http_chunk(
    client: &reqwest::blocking::Client,
    url: &str,
    start: u64,
    size: usize,
    pb: &ProgressBar,
    total_dst_size: usize,
) -> anyhow::Result<Vec<u8>>
```

```rust
use reqwest::blocking::Client;
use indicatif::ProgressBar;

let client = Client::new();
let chunk = fetch_http_chunk(
    &client,
    "https://example.com/ota.zip",
    0x1000,           // start at offset 0x1000
    1024 * 1024,      // fetch 1 MB
    &progress_bar,
    4 * 1024 * 1024,  // output partition is 4 MB
)?;

println!("Downloaded {} bytes", chunk.len());
```

--------------------------------

### Thread Count Out of Range Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the user provides an invalid thread count outside the 1-256 range.

```text
Thread count N is out of range.
Valid range: 1–256
Hint: Use 0 or leave -t unset to auto-detect (recommended).
```

--------------------------------

### Configure PowerShell Execution Policy

Source: https://github.com/syedinsaf/otaripper/blob/main/README.md

Bypass execution policy for the current session to allow running the build script on Windows.

```powershell
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
```

--------------------------------

### DNS Resolution Failure Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the provided URL hostname cannot be resolved.

```text
Failed to resolve hostname: [details]
```

--------------------------------

### JSON Output Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when the application fails to write the JSON output file.

```text
JSON error: [details]
```

--------------------------------

### Define ArbMetadata struct

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Represents the parsed ARB metadata, which is compatible with serde for JSON serialization.

```rust
struct ArbMetadata {
    device_model: String,
    update_label: String,
    image: String,
    major: u32,
    minor: u32,
    arb: u32,
    hash_offset: u64,
    hash_size: u64,
}
```

--------------------------------

### Metadata Not Found Error Messages

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/api-reference/arbscan.md

Error messages returned when the ARB metadata signature is missing or incomplete within the ELF segments.

```text
Metadata error: ARB metadata not found in any segment
Metadata error: Incomplete metadata (truncated file?)
```

--------------------------------

### Linux ELF Detection Error Message

Source: https://github.com/syedinsaf/otaripper/blob/main/_autodocs/errors.md

Displayed when a Linux binary is provided.

```text
🐧 This is a Linux system file.
I only extract Android updates, and this isn't one of them.
```
Tokens:
Raw