Struct OwnedInstallRuleset 

pub struct OwnedInstallRuleset { /* private fields */ }

An owned set of install rules with optional exclude glob and default rule.

Unlike InstallRuleset, this struct owns all its data. Use as_ref() to borrow it as an InstallRuleset.

Examples

use camino::Utf8Path;
use loadsmith_install::{OwnedInstallRuleset, InstallRule, GlobRule};

let rules: Vec<InstallRule> = vec![
    GlobRule::try_from_pattern("*.dll", Utf8Path::new("BepInEx/plugins")).unwrap().into(),
];
let owned = OwnedInstallRuleset::with_rules(rules, None).unwrap();
let borrowed = owned.as_ref();
assert_eq!(borrowed.rules().len(), 1);

Implementations

impl OwnedInstallRuleset

pub fn from_rule_iter<I, R>( rules: I, default_rule_index: Option<usize>, ) -> Option<Self>

where I: IntoIterator<Item = R>, R: Into<InstallRule>,

Creates an OwnedInstallRuleset from an iterator of items that convert into InstallRule.

Returns None if default_rule_index is out of bounds.

pub fn with_rules( rules: Vec<InstallRule>, default_rule_index: Option<usize>, ) -> Option<Self>

Creates an OwnedInstallRuleset from a vector of rules.

Returns None if default_rule_index is out of bounds.

pub fn with_exclude(self, exclude: GlobSet) -> Self

Sets an exclude glob set using builder pattern.

pub fn add_rule(&mut self, rule: InstallRule)

Appends a rule to the end of the rule list.

pub fn insert_rule(&mut self, index: usize, rule: InstallRule)

Inserts a rule at the given index, adjusting the default rule index if needed.

pub fn set_exclude(&mut self, exclude: GlobSet)

Replaces or sets the exclude glob set.

pub fn rules(&self) -> &[InstallRule]

Returns a reference to the list of rules.

pub fn default_rule(&self) -> Option<&InstallRule>

Returns the default rule, if any.

pub fn exclude(&self) -> Option<&GlobSet>

Returns the exclude glob set, if any.

pub fn into_parts(self) -> (Vec<InstallRule>, Option<usize>, Option<GlobSet>)

Consumes the ruleset and returns the inner parts: (rules, default_rule_index, exclude).

pub fn as_ref(&self) -> InstallRuleset<'_>

Borrows this owned ruleset as an InstallRuleset.

Trait Implementations

impl Clone for OwnedInstallRuleset

fn clone(&self) -> OwnedInstallRuleset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedInstallRuleset

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

Formats the value using the given formatter.

impl Default for OwnedInstallRuleset

fn default() -> OwnedInstallRuleset

Returns the “default value” for a type.