Struct multiboot2_header::Multiboot2Header

#[repr(transparent)]
pub struct Multiboot2Header<'a> { /* private fields */ }

Wrapper type around a pointer to the Multiboot2 header. The Multiboot2 header is the Multiboot2BasicHeader followed by all tags (see crate::tags::HeaderTagType). Use this if you get a pointer to the header and just want to parse it. If you want to construct the type by yourself, please look at crate::builder::Multiboot2HeaderBuilder.

Implementations

impl<'a> Multiboot2Header<'a>

pub unsafe fn from_addr(addr: usize) -> Self

Public constructor for this type with various validations. It panics if the address is invalid. It panics rather than returning a result, because if this fails, it is a fatal, unrecoverable error anyways and a bug in your code.

Panics

Panics if one of the following conditions is true:

• addr is a null-pointer
• addr isn’t 8-byte aligned
• the magic value of the header is not present
• the checksum field is invalid

Safety

This function may produce undefined behaviour, if the provided addr is not a valid Multiboot2 header pointer.

pub const fn verify_checksum(&self) -> bool

Wrapper around Multiboot2BasicHeader::verify_checksum.

pub const fn header_magic(&self) -> u32

Wrapper around Multiboot2BasicHeader::header_magic.

pub const fn arch(&self) -> HeaderTagISA

Wrapper around Multiboot2BasicHeader::arch.

pub const fn length(&self) -> u32

Wrapper around Multiboot2BasicHeader::length.

pub const fn checksum(&self) -> u32

Wrapper around Multiboot2BasicHeader::checksum.

pub fn iter(&self) -> Multiboot2HeaderTagIter

Wrapper around Multiboot2BasicHeader::tag_iter.

pub const fn calc_checksum(magic: u32, arch: HeaderTagISA, length: u32) -> u32

Wrapper around Multiboot2BasicHeader::calc_checksum.

Trait Implementations

impl<'a> Debug for Multiboot2Header<'a>

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

Formats the value using the given formatter.