Skip to main content

SymlinkFarm

Struct SymlinkFarm 

Source
pub struct SymlinkFarm<S = Materialized> {
    pub staging_dir: PathBuf,
    pub links: HashMap<String, PathBuf>,
    /* private fields */
}
Expand description

A symlink farm mapping relative file paths to their source locations.

Uses a typestate pattern (BuiltMaterialized) to enforce at compile time that materialize() must be called before deploy_to(). The PhantomData<S> marker is zero-sized and erased at runtime.

Fields§

§staging_dir: PathBuf

The staging directory for this profile.

§links: HashMap<String, PathBuf>

Map of relative path -> absolute source path (winner after priority resolution).

Implementations§

Source§

impl SymlinkFarm<Built>

Construct a Built farm directly from a staging directory and link map.

Source

pub fn build( profile_name: &str, resolved: &ResolvedLoadOrder, mod_files: &HashMap<ModId, Vec<(String, PathBuf)>>, overrides: Option<&[(String, PathBuf)]>, hidden: Option<&HashSet<(String, String)>>, ) -> Result<Self>

Build a symlink farm from a resolved load order and the content-addressed store.

mod_files maps each mod ID to its list of (relative_path, store_entry_path) pairs. overrides (if provided) are layered on top — override files win over all mods. hidden is a set of (mod_id, rel_path) pairs to exclude from the farm.

Source

pub async fn materialize(self) -> Result<SymlinkFarm<Materialized>>

Materialize the symlink farm on disk, transitioning to Materialized state.

Source§

impl SymlinkFarm<Materialized>

Source

pub async fn deploy_to(&self, target: &Path) -> Result<()>

Deploy the materialized staging directory into the game’s mod directory.

Creates symlinks in target pointing to the corresponding files in staging_dir.

Trait Implementations§

Source§

impl<S: Clone> Clone for SymlinkFarm<S>

Source§

fn clone(&self) -> SymlinkFarm<S>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: Debug> Debug for SymlinkFarm<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for SymlinkFarm<S>

§

impl<S> RefUnwindSafe for SymlinkFarm<S>
where S: RefUnwindSafe,

§

impl<S> Send for SymlinkFarm<S>
where S: Send,

§

impl<S> Sync for SymlinkFarm<S>
where S: Sync,

§

impl<S> Unpin for SymlinkFarm<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for SymlinkFarm<S>

§

impl<S> UnwindSafe for SymlinkFarm<S>
where S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more