Struct multiboot2_header::builder::InformationRequestHeaderTagBuilder

pub struct InformationRequestHeaderTagBuilder { /* private fields */ }

Helper to build the dynamically sized InformationRequestHeaderTag at runtime. The information request tag has a dedicated builder because this way one can dynamically attach several requests to it. Otherwise, the number of requested tags must be known at compile time.

Implementations

impl InformationRequestHeaderTagBuilder

pub const fn new(flag: HeaderTagFlag) -> Self

New builder.

Examples found in repository

examples/minimal.rs (line 20)

fn main() {
    // We create a Multiboot2 header during runtime here. A practical example is that your
    // program gets the header from a file and parses it afterwards.
    let mb2_hdr_bytes = HeaderBuilder::new(HeaderTagISA::I386)
        .relocatable_tag(RelocatableHeaderTag::new(
            HeaderTagFlag::Required,
            0x1337,
            0xdeadbeef,
            4096,
            RelocatableHeaderTagPreference::None,
        ))
        .information_request_tag(
            InformationRequestHeaderTagBuilder::new(HeaderTagFlag::Required)
                .add_irs(&[MbiTagType::Cmdline, MbiTagType::BootLoaderName]),
        )
        .build();

    // Cast bytes in vector to Multiboot2 information structure
    let mb2_hdr = unsafe { Multiboot2Header::load(mb2_hdr_bytes.as_ptr().cast()) };
    println!("{:#?}", mb2_hdr);
}

pub fn expected_len(&self) -> usize

Returns the expected length of the information request tag, when the build-method gets called.

pub fn add_ir(self, tag: MbiTagType) -> Self

Adds an MbiTagType to the information request.

pub fn add_irs(self, tags: &[MbiTagType]) -> Self

Adds multiple MbiTagType to the information request.

Examples found in repository

examples/minimal.rs (line 21)

fn main() {
    // We create a Multiboot2 header during runtime here. A practical example is that your
    // program gets the header from a file and parses it afterwards.
    let mb2_hdr_bytes = HeaderBuilder::new(HeaderTagISA::I386)
        .relocatable_tag(RelocatableHeaderTag::new(
            HeaderTagFlag::Required,
            0x1337,
            0xdeadbeef,
            4096,
            RelocatableHeaderTagPreference::None,
        ))
        .information_request_tag(
            InformationRequestHeaderTagBuilder::new(HeaderTagFlag::Required)
                .add_irs(&[MbiTagType::Cmdline, MbiTagType::BootLoaderName]),
        )
        .build();

    // Cast bytes in vector to Multiboot2 information structure
    let mb2_hdr = unsafe { Multiboot2Header::load(mb2_hdr_bytes.as_ptr().cast()) };
    println!("{:#?}", mb2_hdr);
}

pub fn build(self) -> Vec<u8>

Builds the bytes of the dynamically sized information request header.

Trait Implementations

impl Clone for InformationRequestHeaderTagBuilder

fn clone(&self) -> InformationRequestHeaderTagBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InformationRequestHeaderTagBuilder

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

Formats the value using the given formatter.

impl PartialEq for InformationRequestHeaderTagBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for InformationRequestHeaderTagBuilder

impl StructuralPartialEq for InformationRequestHeaderTagBuilder