Struct multiboot2::CommandLineTag

#[repr(C)]
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) -> BoxedDst<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 Ord for CommandLineTag

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

This method returns an Ordering between self and other.

impl PartialEq<CommandLineTag> for CommandLineTag

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

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 CommandLineTagwhere [u8]: Pointee,

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

The type for metadata in pointers and references to Self.

impl TagTrait for CommandLineTag

const ID: TagType = TagType::Cmdline

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<'a>(tag: &Tag) -> &'a 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 CommandLineTag

impl StructuralEq for CommandLineTag

impl StructuralPartialEq for CommandLineTag