Struct PackSetting 

#[non_exhaustive]
pub struct PackSetting {
    pub key: String,
    pub default: Value,
    pub doc: String,
    pub stage: Stage,
    pub synced: bool,
    pub min: Option<f64>,
    pub max: Option<f64>,
    pub choices: Vec<Value>,
    pub text: String,
}

One setting of a pack, a [[setting]] table of pack.toml.

Examples

use enshwick::config::Stage;
use enshwick::packs::PackManifest;

let manifest = PackManifest::parse(r#"
id = "you.greeter"
version = "1.0.0"

[[setting]]
key = "greeting"
default = "Welcome"
doc = "What a player who joins reads."

[[setting]]
key = "every"
default = 30
min = 1
stage = "startup"
"#)?;
let schema = manifest.settings_schema().ok_or("no settings")?;
assert_eq!(schema.fields[1].stage, Stage::Startup);
assert_eq!(schema.fields[1].min, Some(1.0));

Fields (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.

key: String

The key in the settings file, of [a-z0-9_].

default: Value

The value on first start; its type is the setting’s.

doc: String

What it does, for the file’s comments and the Mods screen.

stage: Stage

When a change takes effect: runtime unless said.

synced: bool

A startup setting a joined client takes from the server.

min: Option<f64>

The smallest number it accepts.

max: Option<f64>

The largest number it accepts.

choices: Vec<Value>

The values it accepts; empty for any.

text: String

The key of its translated label in the pack’s texts.toml; config.<key> unless said.

Trait Implementations

impl Clone for PackSetting

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackSetting

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackSetting

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PackSetting

Available on crate feature schema only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PackSetting

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PackSetting