Struct Builder 

pub struct Builder { /* private fields */ }

Builder for a Multiboot2 header.

Implementations

impl Builder

pub const fn new(arch: HeaderTagISA) -> Self

Creates a new builder for the specified architecture.

Examples found in repository

examples/minimal.rs (line 11)

fn main() {
    // We create a Multiboot2 header during runtime here. A more practical
    // example, however, would be that you parse the header from kernel binary
    // at runtime.
    let header_bytes = Builder::new(HeaderTagISA::I386)
        .relocatable_tag(RelocatableHeaderTag::new(
            HeaderTagFlag::Required,
            0x1337,
            0xdeadbeef,
            4096,
            RelocatableHeaderTagPreference::None,
        ))
        .information_request_tag(InformationRequestHeaderTag::new(
            HeaderTagFlag::Required,
            &[
                MbiTagType::Cmdline.into(),
                MbiTagType::BootLoaderName.into(),
            ],
        ))
        .build();

    let header = unsafe { Header::load(header_bytes.as_ptr()) }.unwrap();
    println!("{header:#?}");
}

pub fn information_request_tag( self, information_request_tag: Box<InformationRequestHeaderTag>, ) -> Self

Set the InformationRequestHeaderTag tag.

Examples found in repository

examples/minimal.rs (lines 19-25)

fn main() {
    // We create a Multiboot2 header during runtime here. A more practical
    // example, however, would be that you parse the header from kernel binary
    // at runtime.
    let header_bytes = Builder::new(HeaderTagISA::I386)
        .relocatable_tag(RelocatableHeaderTag::new(
            HeaderTagFlag::Required,
            0x1337,
            0xdeadbeef,
            4096,
            RelocatableHeaderTagPreference::None,
        ))
        .information_request_tag(InformationRequestHeaderTag::new(
            HeaderTagFlag::Required,
            &[
                MbiTagType::Cmdline.into(),
                MbiTagType::BootLoaderName.into(),
            ],
        ))
        .build();

    let header = unsafe { Header::load(header_bytes.as_ptr()) }.unwrap();
    println!("{header:#?}");
}

pub const fn address_tag(self, address_tag: AddressHeaderTag) -> Self

Set the AddressHeaderTag tag.

pub const fn entry_tag(self, entry_tag: EntryAddressHeaderTag) -> Self

Set the EntryAddressHeaderTag tag.

pub const fn console_tag(self, console_tag: ConsoleHeaderTag) -> Self

Set the ConsoleHeaderTag tag.

pub const fn framebuffer_tag( self, framebuffer_tag: FramebufferHeaderTag, ) -> Self

Set the FramebufferHeaderTag tag.

pub const fn module_align_tag( self, module_align_tag: ModuleAlignHeaderTag, ) -> Self

Set the ModuleAlignHeaderTag tag.

pub const fn efi_bs_tag(self, efi_bs_tag: EfiBootServiceHeaderTag) -> Self

Set the EfiBootServiceHeaderTag tag.

pub const fn efi_32_tag(self, efi_32_tag: EntryEfi32HeaderTag) -> Self

Set the EntryEfi32HeaderTag tag.

pub const fn efi_64_tag(self, efi_64_tag: EntryEfi64HeaderTag) -> Self

Set the EntryEfi64HeaderTag tag.

pub const fn relocatable_tag( self, relocatable_tag: RelocatableHeaderTag, ) -> Self

Set the RelocatableHeaderTag tag.

Examples found in repository

examples/minimal.rs (lines 12-18)

fn main() {
    // We create a Multiboot2 header during runtime here. A more practical
    // example, however, would be that you parse the header from kernel binary
    // at runtime.
    let header_bytes = Builder::new(HeaderTagISA::I386)
        .relocatable_tag(RelocatableHeaderTag::new(
            HeaderTagFlag::Required,
            0x1337,
            0xdeadbeef,
            4096,
            RelocatableHeaderTagPreference::None,
        ))
        .information_request_tag(InformationRequestHeaderTag::new(
            HeaderTagFlag::Required,
            &[
                MbiTagType::Cmdline.into(),
                MbiTagType::BootLoaderName.into(),
            ],
        ))
        .build();

    let header = unsafe { Header::load(header_bytes.as_ptr()) }.unwrap();
    println!("{header:#?}");
}

pub fn build(self) -> Box<DynSizedStructure<Multiboot2BasicHeader>>

Returns properly aligned bytes on the heap representing a valid Multiboot2 header structure.

Examples found in repository

examples/minimal.rs (line 26)

fn main() {
    // We create a Multiboot2 header during runtime here. A more practical
    // example, however, would be that you parse the header from kernel binary
    // at runtime.
    let header_bytes = Builder::new(HeaderTagISA::I386)
        .relocatable_tag(RelocatableHeaderTag::new(
            HeaderTagFlag::Required,
            0x1337,
            0xdeadbeef,
            4096,
            RelocatableHeaderTagPreference::None,
        ))
        .information_request_tag(InformationRequestHeaderTag::new(
            HeaderTagFlag::Required,
            &[
                MbiTagType::Cmdline.into(),
                MbiTagType::BootLoaderName.into(),
            ],
        ))
        .build();

    let header = unsafe { Header::load(header_bytes.as_ptr()) }.unwrap();
    println!("{header:#?}");
}

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.