Struct GlobRule 

pub struct GlobRule { /* private fields */ }

A glob-based install rule that maps matching files to a target directory.

A GlobRule matches files by a glob pattern and maps them into a target directory, with optional path stripping and subdirectory creation.

Examples

use std::borrow::Cow;
use camino::{Utf8Path, Utf8PathBuf};
use globset::Glob;
use loadsmith_core::{PackageRef, PackageId, Version};
use loadsmith_install::GlobRule;

let rule = GlobRule::try_from_pattern("*.dll", Utf8Path::new("BepInEx/plugins")).unwrap();
let pkg = PackageRef::new(PackageId::new("x753-More_Suits"), Version::new(1, 0, 3));

assert!(rule.matches("MyPlugin.dll"));
assert!(!rule.matches("config.txt"));
assert_eq!(
    rule.map_file("MyPlugin.dll", &pkg),
    Some(Utf8PathBuf::from("BepInEx/plugins/MyPlugin.dll"))
);

Implementations

impl GlobRule

pub fn new(pattern: Glob, target: impl Into<Cow<'static, Utf8Path>>) -> Self

Creates a new GlobRule from a compiled Glob pattern and a target path.

pub fn try_from_pattern( pattern: impl AsRef<str>, target: impl Into<Cow<'static, Utf8Path>>, ) -> Result<Self, Error>

Creates a new GlobRule by compiling a glob pattern string.

Returns a globset::Error if the pattern is invalid.

pub fn strip_top_level(self, strip_top_level: bool) -> Self

Strips the top-level directory component from paths before mapping.

pub fn strip_levels(self, strip_levels: usize) -> Self

Strips the given number of leading path components before mapping.

pub fn use_links(self, use_links: bool) -> Self

Sets whether to use hard links instead of copying files.

pub fn with_subdir(self, subdir: bool) -> Self

Sets whether to create a subdirectory named after the package ID inside the target directory.

pub fn matches(&self, path: impl AsRef<Utf8Path>) -> bool

Returns true if the path matches this rule’s glob pattern.

pub fn map_file( &self, path: impl AsRef<Utf8Path>, package: &PackageRef, ) -> Option<Utf8PathBuf>

Maps a file path to its install destination under the rule’s target directory.

Returns None if stripping removes all path components. When subdir is enabled the package ID is inserted as an intermediate directory.

Trait Implementations

impl Clone for GlobRule

fn clone(&self) -> GlobRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GlobRule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GlobRule

impl From<GlobRule> for InstallRule

fn from(glob: GlobRule) -> Self

Converts to this type from the input type.

impl PartialEq for GlobRule

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GlobRule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GlobRule