Struct Scene 

#[non_exhaustive]
pub struct Scene {
    pub screen: String,
    pub kind: String,
    pub text: String,
    pub data: Value,
    pub shape: Option<Schema>,
}

The scene a stage shows, as text and as data.

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.

screen: String

The screen it is on.

kind: String

What kind of scene: grid map, or the game’s own word.

text: String

The scene as text: for a grid map, its tiles, units and cursor in the scene’s text form (MapScene::to_text).

data: Value

What the game says of it as data: serde’s tree of the value the game names (with_data), by default its stage’s state.

shape: Option<Schema>

The JSON Schema of data, in serialize mode, if the game gave it with with_data: answered only when asked for (scene --shape).

Implementations

impl Scene

pub fn new( screen: impl Into<String>, kind: impl Into<String>, text: impl Into<String>, ) -> Self

The scene of kind kind on the screen screen, as the text text, with no data (null; give it with with_data).

pub fn with_data<T: Serialize + JsonSchema>( self, value: &T, ) -> Result<Self, String>

This scene, its data value’s serde tree and its shape the JSON Schema of T in serialize mode (ADR-0084 §2, §8); or why value doesn’t serialize (a map with keys that aren’t strings).

Trait Implementations

impl Clone for Scene

fn clone(&self) -> Scene

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scene

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scene

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Scene

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 Scene

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Scene

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scene