Struct diskplan_config::Config

pub struct Config<'t> { /* private fields */ }

Application configuration

Implementations

impl<'t> Config<'t>

pub fn new(target: impl AsRef<Utf8Path>, apply: bool) -> Self

Constructs a new application configuration

The target path defines a directory into which we will begin

The apply flag controls whether changes should be applied to the filesystem or just reported

pub fn load(&mut self, path: impl AsRef<Utf8Path>) -> Result<()>

Loads configuation options from the given path

pub fn apply_user_map(&mut self, usermap: HashMap<String, String>)

Updates this configuration’s user name map with the one provided

pub fn apply_group_map(&mut self, groupmap: HashMap<String, String>)

Updates this configuration’s group name map with the one provided

pub fn target_path(&self) -> &Utf8Path

The path intended to be constructed

pub fn will_apply(&self) -> bool

Whether to apply the changes to disk

pub fn add_stem(&mut self, root: Root, schema_path: impl AsRef<Utf8Path>)

Add a root and schema definition file path pair

pub fn add_precached_stem( &mut self, root: Root, schema_path: impl AsRef<Utf8Path>, schema: SchemaNode<'t> )

Add a root and schema definition file path pair, adding its already parsed schema to the cache

The file path will not be read; this can be used for testing

pub fn stem_roots(&self) -> impl Iterator<Item = &Root>

Returns an iterator over the configured Roots

pub fn schema_for<'s, 'p>( &'s self, path: &'p Utf8Path ) -> Result<(&SchemaNode<'t>, &Root)>where 's: 't,

Returns the schema for a given path, loaded on demand, or an error if the schema cannot be found, has a syntax error, or otherwise fails to load

pub fn map_user<'a>(&'a self, name: &'a str) -> &'a str

Applies the user map to the given user name, returning itself if no mapping exists for this name

pub fn map_group<'a>(&'a self, name: &'a str) -> &'a str

Applies the group map to the given group name, returning itself if no mapping exists for this name