Struct RouteRule

Source

pub struct RouteRule { /* private fields */ }

Expand description

A route-based install rule that maps files by directory name and file extension.

A RouteRule looks for a named directory component in the input path and maps the remaining suffix into the target directory. File extensions can be used as an additional matching criterion.

§Examples

use camino::Utf8PathBuf;
use loadsmith_core::{PackageRef, PackageId, Version};
use loadsmith_install::RouteRule;

let rule = RouteRule::new_static("BepInEx\\plugins")
    .with_file_extension("dll");
let pkg = PackageRef::new(PackageId::new("x753-More_Suits"), Version::new(1, 0, 3));

assert!(rule.matches("MyPlugin.dll"));
assert!(rule.matches_path("BepInEx\\plugins\\MyPlugin.dll"));
assert_eq!(
    rule.map_file("plugins\\MyPlugin.dll", &pkg),
    Some(Utf8PathBuf::from("BepInEx\\plugins\\x753-More_Suits\\MyPlugin.dll"))
);

Implementations§

Source §

impl RouteRule

Source

pub fn new_static(path: &'static str) -> Self

Creates a route rule from a static path string. The rule name is derived from the last path component.

Source

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

Creates a route rule from any path. The rule name is derived from the last path component.

Source

pub fn new_with_target( name: impl Into<Cow<'static, str>>, target: impl Into<Cow<'static, Utf8Path>>, ) -> Self

Creates a route rule with an explicit name and target path.

The name is the directory component that triggers a match; target is the directory where matched files are installed.

Source

pub fn with_file_extension( self, extension: impl Into<Cow<'static, str>>, ) -> Self

Adds a file extension to the matching set.

Source

pub fn with_file_extensions(self, extensions: Vec<Cow<'static, str>>) -> Self

Replaces the entire set of matching file extensions.

Source

pub fn with_flatten(self, flatten: bool) -> Self

Sets whether to flatten the mapped path (remove intermediate directories).

Source

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

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

Source

pub fn with_mutable(self, mutable: bool) -> Self

Sets whether the rule allows mutable (user-modifiable) files.

Source

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

Returns true if the path matches by extension or by route name.

Source

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

Returns true if the file name has one of the rule’s registered extensions.

Source

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

Returns true if the path contains the route’s name as a path component.

Source

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.

If the path contains the route name, the part before the route name becomes the prefix; otherwise the parent directory becomes the prefix. When subdir is enabled the package ID is inserted as an intermediate directory. When flatten is disabled the prefix is preserved in the output.

Source