Enum InstallRule 

pub enum InstallRule {
    Glob(GlobRule),
    Route(RouteRule),
}

A file-mapping rule that can be either a GlobRule or a RouteRule.

Examples

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

let glob: InstallRule = GlobRule::try_from_pattern("*.dll", Utf8Path::new("BepInEx/plugins")).unwrap().into();
let route: InstallRule = RouteRule::new_static("plugins").into();

Variants

Glob(GlobRule)

Maps files using a glob pattern.

Route(RouteRule)

Maps files by matching a route (directory name) and file extension.

Implementations

impl InstallRule

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

Returns true if the path matches this rule by path content or file extension.

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

Returns true if the path matches this rule by path content.

For Glob rules this checks the glob pattern. For Route rules this looks for the route name in the path.

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

Returns true if the file extension matches this rule.

For Glob rules this is identical to matches_path. For Route rules this checks the registered extensions.

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

Maps a file path to its install destination.

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

Returns true if the mapped path starts with this rule’s target directory.

pub fn use_links(&self) -> bool

Returns true if the rule prefers hard links over file copies.

pub fn conflict_strategy(&self) -> ConflictStrategy

Returns the conflict strategy for this rule.

Glob rules always use Overwrite. Route rules always use Skip.

Trait Implementations

impl Clone for InstallRule

fn clone(&self) -> InstallRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstallRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstallRule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InstallRule

impl From<GlobRule> for InstallRule

fn from(glob: GlobRule) -> Self

Converts to this type from the input type.

impl From<RouteRule> for InstallRule

fn from(route: RouteRule) -> Self

Converts to this type from the input type.

impl PartialEq for InstallRule

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InstallRule

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 InstallRule