Skip to main content

ProfileMod

Struct ProfileMod 

Source
#[non_exhaustive]
pub struct ProfileMod {
Show 20 fields pub manifest_version: u32, pub name: String, pub author_name: String, pub website_url: String, pub display_name: String, pub description: String, pub game_version: String, pub network_mode: String, pub package_type: String, pub install_mode: String, pub installed_at_time: u64, pub loaders: Vec<String>, pub dependencies: Vec<String>, pub incompatibilities: Vec<String>, pub optional_dependencies: Vec<String>, pub version_number: SemVer, pub enabled: bool, pub icon: String, pub online_source: bool, pub trusted_package: bool,
}
Expand description

One installed mod, mirroring r2modman’s ManifestV2. Field order matches r2modman’s declaration order; icon is never serialized.

#[non_exhaustive]: fields may be added as the schema grows.

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.
§manifest_version: u32

The manifest.json schema version the package declared.

§name: String

The package name, without its owner prefix.

§author_name: String

The package owner, as Thunderstore spells it.

§website_url: String

The package’s homepage, or empty when it declared none.

§display_name: String

The name to show a user, which may differ from Self::name.

§description: String

The package’s own description, shown verbatim. Not validated or truncated, so a UI must treat it as untrusted text from an arbitrary uploader.

§game_version: String

The game version the package declared, carried through verbatim.

§network_mode: String

r2modman’s network-mode marker, carried through verbatim.

§package_type: String

r2modman’s package-type marker, carried through verbatim.

§install_mode: String

r2modman’s install-mode marker, carried through verbatim.

§installed_at_time: u64

When the mod was installed, as a Unix timestamp in milliseconds.

§loaders: Vec<String>

Mod loaders the package declared support for.

§dependencies: Vec<String>

Full Owner-Name-Version dependency strings.

§incompatibilities: Vec<String>

Packages this one declares it cannot coexist with.

§optional_dependencies: Vec<String>

Dependencies the package treats as optional.

§version_number: SemVer

The installed version.

§enabled: bool

Whether the mod is currently enabled in the profile.

§icon: String

Never written to mods.yml (r2modman strips it); ignored on read.

§online_source: bool

Whether the mod came from Thunderstore rather than a local import.

§trusted_package: bool

Absent from the mods.yml that installed r2modmanPlus versions actually write, so it must not be required: demanding it made importing a real profile fail with missing field trustedPackage`` after every file had already been copied into place.

Defaulting to false cannot change behavior, because nothing in the engine branches on this flag; it is carried purely so a round-trip through read()/write() does not drop a key a newer r2modman does write. false is also the conservative reading of “is this package trusted”.

Trait Implementations§

Source§

impl Clone for ProfileMod

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 ProfileMod

Source§

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

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

impl<'de> Deserialize<'de> for ProfileMod

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ProfileMod

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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