Struct CommandLineTag

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

This tag contains the command line string.

The string is a normal C-style UTF-8 zero-terminated string that can be obtained via the command_line method.

Implementations

impl CommandLineTag

pub fn new(command_line: &str) -> Box<Self>

Create a new command line tag from the given string.

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

Reads the command line of the kernel as Rust string slice without the null-byte.

For example, this returns "console=ttyS0".if the GRUB config contains "multiboot2 /mykernel console=ttyS0".

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

Examples

if let Some(tag) = boot_info.command_line_tag() {
    let command_line = tag.cmdline();
    assert_eq!(Ok("/bootarg"), command_line);
}

Trait Implementations

impl Debug for CommandLineTag

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

Formats the value using the given formatter.

impl Hash for CommandLineTag

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

Feeds this value into the given Hasher.

impl MaybeDynSized for CommandLineTag

const BASE_SIZE: usize = 8usize

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 CommandLineTag

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

This method returns an Ordering between self and other.

impl PartialEq for CommandLineTag

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

fn partial_cmp(&self, other: &CommandLineTag) -> 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 CommandLineTag

where [u8]: Pointee,

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

The type for metadata in pointers and references to Self.

impl Tag for CommandLineTag

const ID: TagType = TagType::Cmdline

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 CommandLineTag

impl StructuralPartialEq for CommandLineTag