Struct RunInput 

#[non_exhaustive]
pub struct RunInput {
    pub start: Vec<GameArg>,
    pub script: Script,
    pub frames: u32,
    pub perf: bool,
    pub perf_out: Option<String>,
    pub session: Option<SessionInput>,
    pub path: Option<String>,
    pub shape: bool,
}

What run and scene play.

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.

start: Vec<GameArg>

The game’s own start options (frame-png --help lists them), in the order given.

script: Script

The steps to play.

frames: u32

Frames to run after the script with no input.

perf: bool

Measure each frame, and answer a summary of the times (run only).

perf_out: Option<String>

Also write every kept frame’s record there, a JSON line each; a relative path is from the project’s folder. It implies perf.

session: Option<SessionInput>

Start from this session record, played to its end, in place of the start options: the game’s real start is the record’s. A frame that plays differently stops it there, and the script and frames don’t play.

path: Option<String>

Answer only the value at this JSON Pointer (RFC 6901) in the scene’s data, /hero/x (scene only).

shape: bool

Answer the JSON Schema of the scene’s data, as the game derived it (scene only).

Implementations

impl RunInput

pub fn check(&self) -> Result<(), String>

Whether the Harness can play it: every step of its script (frame_png::check), at most MAX_IDLE_FRAMES frames after, and no start options with a session record, whose start is the game’s real one. Its actions’ names are the game’s to check (check_actions).

pub fn measures(&self) -> bool

Whether it measures the frames: perf, or perf_out.

Trait Implementations

impl Clone for RunInput

fn clone(&self) -> RunInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunInput

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

Formats the value using the given formatter.

impl Default for RunInput

fn default() -> RunInput

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunInput

where RunInput: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RunInput

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 RunInput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RunInput

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 RunInput