Struct Config 

#[non_exhaustive]
pub struct Config {

    pub command: Option<String>,
    pub app: Option<AppPart>,
    pub game: Option<GameProgram>,
    pub check_keys: Option<CheckKeys>,
    pub check_text: Option<CheckText>,
    pub rules: Option<String>,
    pub font_atlas: Option<FontAtlas>,
    pub web: Option<Web>,
    pub notices: Option<Notices>,
    pub export: Option<ExportPart>,
    pub disclosure: Option<Disclosure>,
    pub glyph_tiles: Option<GlyphTiles>,
    pub private_assets: Option<PrivateAssets>,
    pub targets: BTreeMap<String, TargetSetting>,
    pub target_profiles: Option<String>,
    pub assets: Option<String>,
}

What shuyi.ron says.

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.

command: Option<String>

What the project calls this tool in what it prints (usage: …, generated files): shuyi unless it says otherwise.

app: Option<AppPart>

Who the game is: its name, id, version and storage’s name, which check --target checks and app-info writes as Rust (crate::app_info).

game: Option<GameProgram>

The game’s tool program, for frame-png and lang-status.

check_keys: Option<CheckKeys>

check-keys.

check_text: Option<CheckText>

check-text.

rules: Option<String>

The game’s rules package, which lint checks is fenced: clippy’s bans and no screen, device or tool crate under it (ADR-0032 §4).

font_atlas: Option<FontAtlas>

font-atlas.

web: Option<Web>

web.

notices: Option<Notices>

The game’s own license texts, which its packages carry.

export: Option<ExportPart>

What export turns on and ships beside the program.

disclosure: Option<Disclosure>

What the game’s packages may hold, which export holds each final package to (crate::export::disclosure).

glyph_tiles: Option<GlyphTiles>

glyph-tiles.

private_assets: Option<PrivateAssets>

private-assets.

targets: BTreeMap<String, TargetSetting>

check --target: the targets the game ships on, by the id of their profile (ADR-0008 §1), and how it shows its frame on each. It lists only those.

target_profiles: Option<String>

The folder of the game’s own target profiles, if it has any: each adds a target, or replaces the engine’s of its id.

assets: Option<String>

The folder of the game’s files, which run --watch lays over the embedded ones: assets unless it says.

Implementations

impl Config

pub fn parse(text: &str) -> Result<Self, String>

Parses the text of a shuyi.ron. A part is written as it is, not in Some(…) (RON’s implicit_some is on).

pub fn command(&self) -> &str

The tool’s name in what it prints.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Config