Struct BLSConfig 

#[non_exhaustive]
pub(crate) struct BLSConfig {
    pub(crate) title: Option<String>,
    version: String,
    pub(crate) cfg_type: BLSConfigType,
    pub(crate) machine_id: Option<String>,
    pub(crate) sort_key: Option<String>,
    pub(crate) extra: HashMap<String, String>,
}

Represents a single Boot Loader Specification config file.

The boot loader should present the available boot menu entries to the user in a sorted list. The list should be sorted by the sort-key field, if it exists, otherwise by the machine-id field. If multiple entries have the same sort-key (or machine-id), they should be sorted by the version field in descending order.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

title: Option<String>

The title of the boot entry, to be displayed in the boot menu.

version: String

The version of the boot entry. See https://uapi-group.org/specifications/specs/version_format_specification/

This is hidden and must be accessed via Self::version();

cfg_type: BLSConfigType

machine_id: Option<String>

The machine ID of the OS.

sort_key: Option<String>

The sort key for the boot menu.

extra: HashMap<String, String>

Any extra fields not defined in the spec.

Implementations

impl BLSConfig

pub(crate) fn version(&self) -> Version

pub(crate) fn with_title(&mut self, new_val: String) -> &mut Self

pub(crate) fn with_version(&mut self, new_val: String) -> &mut Self

pub(crate) fn with_cfg(&mut self, config: BLSConfigType) -> &mut Self

pub(crate) fn with_machine_id(&mut self, new_val: String) -> &mut Self

pub(crate) fn with_sort_key(&mut self, new_val: String) -> &mut Self

pub(crate) fn with_extra( &mut self, new_val: HashMap<String, String>, ) -> &mut Self

pub(crate) fn get_verity(&self) -> Result<String>

pub(crate) fn get_cmdline(&self) -> Result<&Cmdline<'_>>

Gets the options field from the config Returns an error if the field doesn’t exist or if the config is of type EFI

Trait Implementations

impl Debug for BLSConfig

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

Formats the value using the given formatter.

impl Default for BLSConfig

fn default() -> BLSConfig

Returns the “default value” for a type.

impl Display for BLSConfig

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

Formats the value using the given formatter.

impl Ord for BLSConfig

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

This implements the sorting logic from the Boot Loader Specification.

The list should be sorted by the sort-key field, if it exists, otherwise by the machine-id field. If multiple entries have the same sort-key (or machine-id), they should be sorted by the version field in descending order.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BLSConfig

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

fn partial_cmp(&self, other: &Self) -> 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 Eq for BLSConfig

impl StructuralPartialEq for BLSConfig