ModPackageInfo

Struct ModPackageInfo 

Source
pub struct ModPackageInfo {
    pub readme_path: Option<PathBuf>,
    pub faq_path: Option<PathBuf>,
    pub gallery_paths: Vec<PathBuf>,
}
Expand description

Contains unofficial extensions to the info.json format.

Used by third party packaging tools.

Fields§

§readme_path: Option<PathBuf>

The path to a file that should be used as the content for the “information” page on the mod portal.

The mod portal supports markdown formatting, so it’s recommended to specify the path to a markdown file here.

Note that this path is considered relative to the info.json file (unless an absolute path is specified).

§faq_path: Option<PathBuf>

The path to a file that should be used as the content for the “FAQ” page on the mod portal.

The mod portal supports markdown formatting, so it’s recommended to specify the path to a markdown file here.

Note that this path is considered relative to the info.json file (unless an absolute path is specified).

§gallery_paths: Vec<PathBuf>

Paths to images that should be displayed on the mod portal.

If mod details are updated with Facti, the images will be displayed on the mod portal in the same order that they are specified in this Vec.

Note that these paths are considered relative to the info.json file (unless absolute paths are specified).

Trait Implementations§

Source§

impl Clone for ModPackageInfo

Source§

fn clone(&self) -> ModPackageInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModPackageInfo

Source§

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

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

impl Default for ModPackageInfo

Source§

fn default() -> ModPackageInfo

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

impl<'de> Deserialize<'de> for ModPackageInfo

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 PartialEq for ModPackageInfo

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ModPackageInfo

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

impl Eq for ModPackageInfo

Source§

impl StructuralPartialEq for ModPackageInfo

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,