Struct df_st_core::df_st_info::DFSTInfo

pub struct DFSTInfo {
    pub version: String,
    pub enabled_features: Vec<String>,
    pub enabled_mods: Vec<ModInfo>,
    pub base_url: String,
    pub world_id: i32,
}

Information about DF Storyteller itself

Fields

version: String

The version of DF Storyteller currently running. This used the Semantic Versioning system. Example: "0.1.0" or "1.5.10" For pre-releases an addition might be added after the last number. The last number will then always be followed by a dash -. Example: "0.1.5-alpha-1" or "2.10.1-beta-2"

Only the major and minor version should be used in most cases. So for "0.5.7" only "0.5" should be checked. The "7" will just define the patches. The patches should not break anything (only fix them)

The following Regex expression can be used the check this field: Regex match: ^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+))?$ This will match "2.13.1-beta-5" to:

• Group #1: "2"
• Group #2: "13"
• Group #3: "1"
• Group #4: "beta-5"

enabled_features: Vec<String>

Features that are enabled in DF Storyteller. This will be used to specified if a feature is enabled on this install. Future features might include: "maps", "dm_mode", "discovery_mode", ...

enabled_mods: Vec<ModInfo>

A list of enabled modification to the game and DF Storyteller. This list has to be specified in the settings of DF Storyteller. DF Storyteller can not detect mods from Dwarf Fortress.

base_url: String

The Base URL is the first part of the url where api request should go to. This is usually set to http://localhost:20350/api. But can be changes by the user in the settings. This value is also printed in the output for the user. Paintings can refer to this to get the initial base_url is not set.

world_id: i32

The id of the world that is currently loaded. This is the same value as the -w X flag, where X is the world id. This value can only be positive as negative numbers are not allowed by the terminal.

Implementations

impl DFSTInfo

pub fn new() -> Self

Trait Implementations

impl Clone for DFSTInfo

fn clone(&self) -> DFSTInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DFSTInfo

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

Formats the value using the given formatter.

impl Default for DFSTInfo

fn default() -> DFSTInfo

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for DFSTInfo

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for DFSTInfo

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl SchemaExample for DFSTInfo

fn example() -> Self

impl Serialize for DFSTInfo

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

Serialize this value into the given Serde serializer.