Skip to main content

LaunchFacts

Struct LaunchFacts 

Source
#[non_exhaustive]
pub struct LaunchFacts { pub doorstop_version: u32, pub preloader: Option<String>, pub has_corlibs: bool, pub loader_scripts: Vec<String>, pub melonloader_assemblies: bool, pub loaders: Vec<LoaderKind>, pub recorded: Vec<String>, }
Expand description

What the launch planner needs to know about a target directory’s contents.

launch_plan_from and loader_args_from decide from these instead of reading the target. With the io feature, LaunchFacts::read gathers them from disk. A caller that already knows them starts from LaunchFacts::default, which describes an empty target, and sets the fields that differ.

§Examples

use thunderstore_engine::profile::launch::{LaunchFacts, LOADER_SCRIPTS};

let mut facts = LaunchFacts::default();

facts.doorstop_version = 4;
facts.loader_scripts = vec![LOADER_SCRIPTS[1].to_string()];

assert_eq!(facts.preloader, None);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§doorstop_version: u32

The Doorstop major version recorded in .doorstop_version, or 3 when the file is missing, unparseable, or below 3. A major of 4 or higher selects the v4 argument spellings.

§preloader: Option<String>

The first PRELOADER_CANDIDATES entry present in BepInEx/core, by file name.

§has_corlibs: bool

Whether an unstripped_corlib directory exists, which needs a Doorstop search-path override.

§loader_scripts: Vec<String>

The LOADER_SCRIPTS present as files in the target root, by name.

§melonloader_assemblies: bool

Whether MelonLoader’s Assembly-CSharp.dll exists in either its 0.5 (MelonLoader/Managed) or 0.6 (MelonLoader/Il2CppAssemblies) layout. When neither does, MelonLoader is asked to regenerate its assembly cache.

§loaders: Vec<LoaderKind>

The loader kinds whose files from LOADER_FILES are in the target. BepInEx and BepisLoader are found through Self::preloader instead.

§recorded: Vec<String>

The package names recorded in the target’s mods.yml, which name the loader pack the engine or r2modman installed.

Implementations§

Source§

impl LaunchFacts

Source

pub fn read(target_dir: &Path) -> Self

Available on crate feature io only.

Reads every fact from target_dir. A missing or unreadable file counts as absent, so this never fails.

Trait Implementations§

Source§

impl Clone for LaunchFacts

Source§

fn clone(&self) -> Self

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 Debug for LaunchFacts

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LaunchFacts

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for LaunchFacts

Source§

impl PartialEq for LaunchFacts

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LaunchFacts

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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