Struct ModuleTag

#[repr(C, align(8))]
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) -> Box<Self>

Constructs a new tag.

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 const fn start_address(&self) -> u32

Start address of the module.

pub const fn end_address(&self) -> u32

End address of the module

pub const 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 MaybeDynSized for ModuleTag

const BASE_SIZE: usize = 16usize

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 = TagHeader

The associated Header of this tag.

fn dst_len(header: &TagHeader) -> 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 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 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

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 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

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 Pointee for ModuleTag

where [u8]: Pointee,

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

The metadata type for pointers and references to this type.

impl Tag for ModuleTag

const ID: TagType = TagType::Module

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

type IDType = TagType

The ID type that identifies the tag.

impl Eq for ModuleTag

impl StructuralPartialEq for ModuleTag