Struct PrototypeApi 

pub struct PrototypeApi {
    pub application: String,
    pub application_version: String,
    pub api_version: Number,
    pub stage: String,
    pub prototypes: Vec<Prototype>,
    pub types: Vec<Concept>,
    pub defines: Vec<Define>,
}

The JSON, deserializable from the machine-readable JSON format file.

See the Factorio documentation for more details.

Fields

application: String

The application this documentation is for. Will always be "factorio".

application_version: String

The version of the game that this documentation is for. An example would be "1.1.90".

api_version: Number

The version of the machine-readable format itself. It is incremented every time the format changes.

stage: String

Indicates the state this documentation is for. Will always be "prototype" (as opposed to "runtime"; see the data lifecycle for more detail).

prototypes: Vec<Prototype>

The list of prototypes that can be created. Equivalent to the prototypes page.

types: Vec<Concept>

The list of types (concepts) that the prototypes use. Equivalent to the types page.

defines: Vec<Define>

The list of defines that the game uses. Equivalent to the defines page.

Implementations

impl PrototypeApi

pub fn try_from_file<P: AsRef<Path>>(path: P) -> Result<Self, LoadingError>

Reads the JSON data from the prototype-api.json file.

Trait Implementations

impl Debug for PrototypeApi

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrototypeApi

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PrototypeApi

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

where __S: Serializer,

Serialize this value into the given Serde serializer.