Struct ModInfoBuilder

pub struct ModInfoBuilder { /* private fields */ }

Contains an internal ModInfo value that is used to later construct a finished ModInfo`.

Implementations

impl ModInfoBuilder

Contains methods to successively build up a ModInfo struct.

pub fn contact<T: Into<String>>(&mut self, contact: T) -> &mut Self

Sets the contact field.

pub fn homepage(&mut self, homepage: Url) -> &mut Self

Sets the homepage field.

pub fn description<T: Into<String>>(&mut self, description: T) -> &mut Self

Sets the description field.

pub fn factorio_version( &mut self, factorio_version: FactorioVersion, ) -> &mut Self

Sets the factorio_version field.

pub fn dependency(&mut self, dependency: Dependency) -> &mut Self

Adds a dependency to dependencies.

pub fn dependencies(&mut self, dependencies: &[Dependency]) -> &mut Self

Adds multiple dependencies at once to dependencies.

pub fn information_path<T: Into<PathBuf>>(&mut self, path: T) -> &mut Self

Sets a path to the readme file that should be displayed on the mod portal.

The path is relative to where the info.json file is located.

Note: This is an unofficial extension to the info.json format.

pub fn faq_path<T: Into<PathBuf>>(&mut self, path: T) -> &mut Self

Sets a path to the FAQ file that should be displayed on the mod portal.

The path is relative to where the info.json file is located.

pub fn gallery<T: Into<PathBuf>>(&mut self, gallery: T) -> &mut Self

Adds a path to the collection of gallery images.

pub fn build(&mut self) -> ModInfo

Builds a finished ModInfo from the builder.