Skip to main content

LaunchContext

Struct LaunchContext 

Source
pub struct LaunchContext<'a> { /* private fields */ }
Expand description

Information about the game and profile directories used when launching a loader.

A LaunchContext holds the paths to the profile directory (where mod files are staged) and the game directory (where the game executable lives), together with a flag indicating whether the game runs under Proton.

§Examples

use loadsmith_loader::LaunchContext;
use camino::Utf8Path;

let ctx = LaunchContext::new(
    Utf8Path::new("/tmp/profile"),
    Utf8Path::new("/tmp/game"),
    false,
);

assert_eq!(ctx.profile_path(), Utf8Path::new("/tmp/profile"));
assert_eq!(ctx.game_path(), Utf8Path::new("/tmp/game"));
assert!(!ctx.is_proton());

Implementations§

Source§

impl<'a> LaunchContext<'a>

Source

pub fn new( profile_path: impl Into<Cow<'a, Utf8Path>>, game_path: impl Into<Cow<'a, Utf8Path>>, is_proton: bool, ) -> Self

Creates a new launch context.

  • profile_path - directory where mod and loader files are staged.
  • game_path - directory containing the game executable.
  • is_proton - whether the game runs via Proton (used for path translation).
Source

pub fn profile_path(&self) -> &Utf8Path

Returns the profile directory path.

Source

pub fn game_path(&self) -> &Utf8Path

Returns the game directory path.

Source

pub fn is_proton(&self) -> bool

Returns true when the game runs under Proton.

Source

pub fn format_proton_path(&self, path: impl Into<Utf8PathBuf>) -> Utf8PathBuf

Formats a path for use with Proton, prepending Z: when is_proton is true.

Source

pub fn copy_file_to_game( &self, relative_source: impl AsRef<Path>, relative_target: impl AsRef<Path>, ) -> Result<()>

Copies a single file from the profile to the game directory.

Skips the copy when the destination already exists and has the same content (determined by hash).

Source

pub fn copy_glob_to_game(&self, patterns: &GlobSet) -> Result<()>

Copies all files in the profile matching a glob set to the game directory, preserving relative paths.

Source

pub fn copy_files_to_game<F>(&self, filter: F) -> Result<()>
where F: Fn(&Path) -> bool,

Copies all files in the profile for which filter returns true to the game directory, preserving relative paths.

Trait Implementations§

Source§

impl<'a> Clone for LaunchContext<'a>

Source§

fn clone(&self) -> LaunchContext<'a>

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<'a> Debug for LaunchContext<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for LaunchContext<'a>

§

impl<'a> RefUnwindSafe for LaunchContext<'a>

§

impl<'a> Send for LaunchContext<'a>

§

impl<'a> Sync for LaunchContext<'a>

§

impl<'a> Unpin for LaunchContext<'a>

§

impl<'a> UnsafeUnpin for LaunchContext<'a>

§

impl<'a> UnwindSafe for LaunchContext<'a>

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> 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