Struct BootLoaderNameTag

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

The bootloader name tag.

Implementations

impl BootLoaderNameTag

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

Constructs a new tag.

pub fn typ(&self) -> TagType

Returns the underlying TagType.

pub const fn size(&self) -> usize

Returns the underlying tag size.

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

Reads the name of the bootloader that is booting the kernel as Rust string slice without the null-byte.

For example, this returns "GRUB 2.02~beta3-5".

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

Examples

if let Some(tag) = boot_info.boot_loader_name_tag() {
    assert_eq!(Ok("GRUB 2.02~beta3-5"), tag.name());
}

Trait Implementations

impl Debug for BootLoaderNameTag

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

Formats the value using the given formatter.

impl Hash for BootLoaderNameTag

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

Feeds this value into the given [Hasher].

impl MaybeDynSized for BootLoaderNameTag

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 BootLoaderNameTag

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

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

impl PartialEq for BootLoaderNameTag

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

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

where [u8]: Pointee,

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

The metadata type for pointers and references to this type.

impl Tag for BootLoaderNameTag

const ID: TagType = TagType::BootLoaderName

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 BootLoaderNameTag

impl StructuralPartialEq for BootLoaderNameTag