Struct multiboot2::ModuleTag

#[repr(C)]
pub struct ModuleTag { /* private fields */ }

The module tag can occur multiple times and specifies passed boot modules (blobs in memory). The tag itself doesn’t include the blog, but references its location.

Implementations

impl ModuleTag

pub fn new(start: u32, end: u32, cmdline: &str) -> BoxedDst<Self>

pub fn cmdline(&self) -> Result<&str, StringError>

Reads the command line of the boot module as Rust string slice without the null-byte. This is an null-terminated UTF-8 string. If this returns Err then perhaps the memory is invalid or the bootloader doesn’t follow the spec.

For example, this returns "--test cmdline-option".if the GRUB config contains "module2 /some_boot_module --test cmdline-option".

If the function returns Err then perhaps the memory is invalid.

pub fn start_address(&self) -> u32

Start address of the module.

pub fn end_address(&self) -> u32

End address of the module

pub fn module_size(&self) -> u32

The size of the module/the BLOB in memory.

Trait Implementations

impl Debug for ModuleTag

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

Formats the value using the given formatter.

impl Hash for ModuleTag

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

Feeds this value into the given [Hasher].

impl Ord for ModuleTag

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

This method returns an [Ordering] between self and other.

impl PartialEq for ModuleTag

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Pointee for ModuleTag

where [u8]: Pointee,

type Metadata = <[u8] as Pointee>::Metadata

The type for metadata in pointers and references to Self.

impl TagTrait for ModuleTag

const ID: TagType = TagType::Module

The numeric ID of this tag.

fn dst_size(base_tag: &Tag) -> usize

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 as_base_tag(&self) -> &Tag

Returns the tag as the common base tag structure.

fn size(&self) -> usize

Returns the total size of the tag. The depends on the size field of the tag.

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

Returns a slice to the underlying bytes of the tag. This includes all bytes, also for tags that are DSTs. The slice length depends on the size field of the tag.

unsafe fn from_base_tag(tag: &Tag) -> &Self

Creates a reference to a (dynamically sized) tag type in a safe way. DST tags need to implement a proper Self::dst_size implementation.

impl Eq for ModuleTag

impl StructuralPartialEq for ModuleTag