Enum Header 

pub enum Header {
    V0(HeaderV0),
    V3(HeaderV3),
}

Standard Android boot image header for versions 0 through 4

Variants

V0(HeaderV0)

Header for versions 0-2

V3(HeaderV3)

Header for versions 3-4

Implementations

impl Header

pub fn parse<R: Read + Seek>(reader: &mut R) -> Result<Self, Error>

Parses a standard Android boot image header from a reader.

Errors

This returns an error if reading fails or if the header is invalid.

Examples found in repository

examples/extract-kernel.rs (line 12)

fn main() {
    let mut r = BufReader::new(File::open("boot_a.img").unwrap());
    let hdr = Header::parse(&mut r).unwrap();
    println!("{hdr:#?}");

    println!("kernel position: {}", hdr.kernel_position());
    let mut w = BufWriter::new(File::create("boot_a_kernel").unwrap());
    let r = r.get_mut();
    r.seek(SeekFrom::Start(hdr.kernel_position() as u64))
        .unwrap();
    io::copy(&mut r.take(hdr.kernel_size().into()), w.get_mut()).unwrap();
}

pub fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Serializes a standard Android boot image header to a writer.

Note that you must write the kernel, ramdisk, etc. yourself.

Errors

This forwards errors from writer.

pub const fn header_version(&self) -> u32

Returns the boot image header’s version number.

pub const fn osversionpatch(&self) -> OsVersionPatch

Returns the boot image header’s OS version and patch level.

pub const fn kernel_position(&self) -> usize

Returns the kernel’s position in the boot image.

Examples found in repository

examples/extract-kernel.rs (line 15)

fn main() {
    let mut r = BufReader::new(File::open("boot_a.img").unwrap());
    let hdr = Header::parse(&mut r).unwrap();
    println!("{hdr:#?}");

    println!("kernel position: {}", hdr.kernel_position());
    let mut w = BufWriter::new(File::create("boot_a_kernel").unwrap());
    let r = r.get_mut();
    r.seek(SeekFrom::Start(hdr.kernel_position() as u64))
        .unwrap();
    io::copy(&mut r.take(hdr.kernel_size().into()), w.get_mut()).unwrap();
}

pub const fn kernel_size(&self) -> u32

Returns the kernel’s size.

Examples found in repository

examples/extract-kernel.rs (line 20)

fn main() {
    let mut r = BufReader::new(File::open("boot_a.img").unwrap());
    let hdr = Header::parse(&mut r).unwrap();
    println!("{hdr:#?}");

    println!("kernel position: {}", hdr.kernel_position());
    let mut w = BufWriter::new(File::create("boot_a_kernel").unwrap());
    let r = r.get_mut();
    r.seek(SeekFrom::Start(hdr.kernel_position() as u64))
        .unwrap();
    io::copy(&mut r.take(hdr.kernel_size().into()), w.get_mut()).unwrap();
}

pub const fn ramdisk_position(&self) -> usize

Returns the ramdisk’s position in the boot image.

pub const fn ramdisk_size(&self) -> u32

Returns the ramdisk’s size.

pub const fn page_size(&self) -> usize

Returns the page size in bytes.

pub const fn cmdline(&self) -> &[u8; 1536]

Returns the kernel command line.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Header

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Header

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Header

fn eq(&self, other: &Header) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Header

impl StructuralPartialEq for Header