Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub options: ConfigRuntimeOptions,
    pub files: Vec<FileOperation>,
    pub commands: Vec<CommandOperation>,
}
Expand description

Parsed and normalized treeboot config.

Fields§

§options: ConfigRuntimeOptions

Runtime options declared by the config.

§files: Vec<FileOperation>

Ordered file operations.

§commands: Vec<CommandOperation>

Ordered command operations.

Implementations§

Source§

impl Config

Source

pub fn load(path: &Path, context: &Worktree) -> Result<Self>

Loads and parses a treeboot config from disk.

Relative paths inside the config are normalized against the supplied worktree context.

§Errors

Returns an error if the config cannot be read or TOML parsing and normalization fails.

Source

pub fn parse(path: &Path, content: &str, context: &Worktree) -> Result<Self>

Parses a treeboot config string.

The path is used for diagnostics. Relative paths inside the config are normalized against the supplied worktree context.

§Errors

Returns an error if TOML parsing or normalization fails.

Source

pub fn discover_path( context: &Worktree, requested_config: Option<&Path>, ) -> Result<Option<PathBuf>>

Discovers the selected treeboot config path for a worktree.

When requested_config is provided, it is resolved relative to the worktree path and must exist. When omitted, standard treeboot config paths are searched in precedence order.

§Errors

Returns an error when a requested config path does not exist.

Source

pub fn load_discovered( context: &Worktree, requested_config: Option<&Path>, ) -> Result<Option<LoadedConfig>>

Discovers, loads, and parses the selected treeboot config.

Returns Ok(None) when no config was requested and no standard config path exists.

§Errors

Returns an error if a requested config path does not exist, the selected config cannot be read, or TOML parsing and normalization fails.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Config

Source§

impl PartialEq for Config

Source§

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Config

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.