Struct boot_loader_spec::BLSEntry

pub struct BLSEntry {

    pub title: Option<BLSValue>,
    pub version: Option<BLSValue>,
    pub machine_id: Option<BLSValue>,
    pub sort_key: Option<BLSValue>,
    pub linux: BLSValue,
    pub efi: Option<BLSValue>,
    pub initrd: Vec<BLSValue>,
    pub options: Vec<BLSValue>,
    pub devicetree: Option<BLSValue>,
    pub devicetree_overlay: Option<BLSValue>,
    pub architecture: Option<BLSValue>,
    pub grub_hotkey: Option<BLSValue>,
    pub grub_users: Option<BLSValue>,
    pub grub_class: Vec<BLSValue>,
    pub grub_arg: Option<BLSValue>,
    pub comments: Vec<String>,
}

BLSEntry represents the contents of a BLS entry file

Fields

title: Option<BLSValue>

version: Option<BLSValue>

machine_id: Option<BLSValue>

sort_key: Option<BLSValue>

linux: BLSValue

efi: Option<BLSValue>

initrd: Vec<BLSValue>

options: Vec<BLSValue>

devicetree: Option<BLSValue>

devicetree_overlay: Option<BLSValue>

architecture: Option<BLSValue>

grub_hotkey: Option<BLSValue>

grub_users: Option<BLSValue>

grub_class: Vec<BLSValue>

grub_arg: Option<BLSValue>

comments: Vec<String>

Implementations

impl BLSEntry

pub fn new() -> BLSEntry

Allocates a new instance of BLSEntry, all optional members are initialized to None and linux is set with an empty string

pub fn parse(buffer: &str) -> Result<BLSEntry, String>

Parses a Boot Loader Spec entry UTF-8 buffer, returns a BLSEntry instance if successful, an error String if there was an error Note that any comment lines that are then rendered using BLSEntry::parse() will be pushed to the header of the file as the order commands and comments are not preserved.

pub fn render(&self) -> String

Renders the BLSEntry content into a UTF-8 String

pub fn set(
    &mut self,
    key: &str,
    value: String,
    comment: Option<String>,
    set_policy: ValueSetPolicy
) -> Result<(), String>

Sets a value for a given key

Arguments

• key: a &str representing the key to be set
• value: a String representing the value for the key
• comment: an optional String reprensenting an inline comment for the value
• set_policy: Some keys can hold multiple values, the ValueSetPolicy enum specifies the policy for keys that can be specified multiple times.

Returns

Ok(()) if the key was succesfully set.

Errors

Returns an Err(String) if an invalid key is set.

Panics

If ValueSetPolicy::InsertAt(usize) is used as set_policy it may cause a panic if the index is out of bound

Trait Implementations

impl Debug for BLSEntry

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

Formats the value using the given formatter.