Struct ConfigBuilder

pub struct ConfigBuilder { /* private fields */ }

A builder to configure a Config

Example

use bootmgr_rs_core::config::builder::ConfigBuilder;
use uefi::{boot, proto::{device_path::DevicePath, loaded_image::LoadedImage, media::fs::SimpleFileSystem}};

let handle = {
    let loaded_image =
        boot::open_protocol_exclusive::<LoadedImage>(boot::image_handle()).expect("Failed to open LoadedImage on image");
    let device_handle = loaded_image.device().expect("Image was not loaded from a filesystem");
    let device_path = boot::open_protocol_exclusive::<DevicePath>(device_handle).expect("Failed to get device path from image filesystem");
    boot::locate_device_path::<SimpleFileSystem>(&mut &*device_path).expect("Failed to get SimpleFileSystem on image filesystem")
};

let config = ConfigBuilder::new("foo.conf", ".conf")
    .title("foo")
    .fs_handle(handle)
    .build();

Implementations

impl ConfigBuilder

pub fn new(filename: impl Into<String>, suffix: impl Into<String>) -> Self

Constructs a new Config.

pub fn title(self, title: impl Into<String>) -> Self

Sets the title of a Config.

pub fn version(self, version: impl Into<String>) -> Self

Sets the version of a Config.

pub fn machine_id(self, machine_id: impl Into<String>) -> Self

Sets the machine id of a Config.

This must be formatted as 32 lower case hexadecimal characters as defined in BootLoaderSpec. Otherwise, this will have no effect

pub fn sort_key(self, sort_key: impl Into<String>) -> Self

Sets the sort key of a Config

Ideally, this should be entirely composed of lowercase characters, with nothing else other than numbers, dashes, underscores, and periods.

pub fn options(self, options: impl Into<String>) -> Self

Sets the options of a Config

This essentially sets the LoadOptions, or the command line of an EFI shell

pub fn devicetree_path(self, devicetree_path: impl Into<String>) -> Self

Sets the devicetree of a Config

pub fn architecture(self, architecture: impl Into<String>) -> Self

Sets the architecture of a Config

This is only used for filtering entries

pub const fn set_bad(self, bad: bool) -> Self

Sets if a Config is bad, so it may be deranked

pub const fn action(self, action: BootAction) -> Self

Sets the BootAction of a Config

This can be one of BootAction::BootEfi, BootAction::BootTftp, BootAction::Reboot, BootAction::Shutdown, and BootAction::ResetToFirmware. You should never need to use this

pub fn fs_handle(self, fs_handle: Handle) -> Self

Sets the Handle of a Config

This is used for filesystem operations, so it is required to be set to indicate which filesystem a Config comes from

pub const fn origin(self, origin: Parsers) -> Self

Sets the origin of a Config.

This is one of the parsers that generate Configs.

pub fn efi_path(self, efi_path: impl Into<String>) -> Self

Sets the EFI executable path of a Config.

pub fn build(self) -> Config

Builds a Config

pub fn assign_if_some<F, T>(self, value: Option<T>, assign: F) -> Self

where F: FnOnce(Self, T) -> Self,

Assigns a value to a field in a Config if it is Some.

Trait Implementations

impl From<&Config> for ConfigBuilder

fn from(value: &Config) -> Self

Converts to this type from the input type.