Struct RelocatableHeaderTag 

#[repr(C, align(8))]
pub struct RelocatableHeaderTag { /* private fields */ }

This tag indicates that the image is relocatable.

Implementations

impl RelocatableHeaderTag

pub const fn new( flags: HeaderTagFlag, min_addr: u32, max_addr: u32, align: u32, preference: RelocatableHeaderTagPreference, ) -> Self

Constructs a new tag.

Examples found in repository

examples/minimal.rs (lines 14-20)

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 mb2_hdr_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();

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

pub const fn typ(&self) -> HeaderTagType

Returns the HeaderTagType.

pub const fn flags(&self) -> HeaderTagFlag

Returns the HeaderTagFlags.

pub const fn size(&self) -> u32

Returns the size.

pub const fn min_addr(&self) -> u32

Return the minimum address.

pub const fn max_addr(&self) -> u32

Return the maximum address.

pub const fn align(&self) -> u32

Return the alignment.

pub const fn preference(&self) -> RelocatableHeaderTagPreference

Return the preference.

Trait Implementations

impl Clone for RelocatableHeaderTag

fn clone(&self) -> RelocatableHeaderTag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelocatableHeaderTag

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

Formats the value using the given formatter.

impl Hash for RelocatableHeaderTag

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 MaybeDynSized for RelocatableHeaderTag

const BASE_SIZE: usize = 24usize

The true base size of the struct without any implicit or additional padding. Note that size_of::<T>() isn’t sufficient, as for example the type could have three u32 fields, which would add an implicit u32 padding. However, this constant must always fulfill BASE_SIZE >= size_of::<Self::Header>().

type Header = HeaderTagHeader

The associated Header of this tag.

fn dst_len(_header: &Self::Header) -> Self::Metadata

Returns the amount of items in the dynamically sized portion of the DST. Note that this is not the amount of bytes. So if the dynamically sized portion is 16 bytes in size and each element is 4 bytes big, then this function must return 4.

fn header(&self) -> &Self::Header

Returns the corresponding Header.

fn payload(&self) -> &[u8]

Returns the payload, i.e., all memory that is not occupied by the Header of the type.

fn as_bytes(&self) -> BytesRef<'_, Self::Header>

Returns the whole allocated bytes for this structure encapsulated in BytesRef. This includes padding bytes. To only get the “true” tag data, read the tag size from Self::header and create a sub slice.

fn as_ptr(&self) -> *const Self::Header

Returns a pointer to this structure.

impl Ord for RelocatableHeaderTag

fn cmp(&self, other: &RelocatableHeaderTag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RelocatableHeaderTag

fn eq(&self, other: &RelocatableHeaderTag) -> 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 PartialOrd for RelocatableHeaderTag

fn partial_cmp(&self, other: &RelocatableHeaderTag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Tag for RelocatableHeaderTag

const ID: HeaderTagType = HeaderTagType::Relocatable

The ID of this tag. This should be unique across all implementors.

type IDType = HeaderTagType

The ID type that identifies the tag.

impl Copy for RelocatableHeaderTag

impl Eq for RelocatableHeaderTag

impl StructuralPartialEq for RelocatableHeaderTag