Struct SessionRecord 

#[non_exhaustive]
pub struct SessionRecord {
    pub format_version: u32,
    pub made: Option<Made>,
    pub display: DisplayInfo,
    pub platform: PlatformFacts,
    pub storage: BTreeMap<String, String>,
    pub storage_complete: bool,
    pub voice_manifest: Option<String>,
    pub start: u64,
    pub reloaded_at: Option<u32>,
    pub truncated: bool,
    pub frames: Vec<FrameRecord>,
}

One run of a game, as the platform gave it (module docs). App fills one in (App::session); from_ron reads one back.

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.

format_version: u32

The version of its text (FORMAT_VERSION).

made: Option<Made>

The build that made it (Start::made).

display: DisplayInfo

The display the game’s load was given.

platform: PlatformFacts

Where the game ran: what the game’s load was given (Platform::facts).

storage: BTreeMap<String, String>

Every key and value in the store when it was handed over.

storage_complete: bool

Whether all of the store was read: false if its keys or a value couldn’t be, or it hasn’t been handed over.

voice_manifest: Option<String>

The text of the voice manifest a backend put into the game’s Setup, which App can’t see: the backend gives it with App::session_mut.

start: u64

The time of the first frame on the backend’s clock.

reloaded_at: Option<u32>

The first frame whose changed_files named files: their new bytes aren’t in the record, so frames after it may play differently.

truncated: bool

Whether recording stopped early: at MAX_SESSION_FRAMES, or on an App::frame_after, whose time isn’t whole milliseconds.

frames: Vec<FrameRecord>

Its frames, in order.

Implementations

impl SessionRecord

pub fn new() -> Self

A record of no frames, of a game not loaded yet.

pub fn to_ron(&self) -> String

The record’s text: RON, one frame per line.

pub fn from_ron(text: &str) -> Result<Self, SessionError>

The record text holds. Another version is refused, whatever else its text holds: a record is never migrated.

pub fn limits(&self) -> Vec<String>

What a playback of this record can’t promise, one line each: frames it doesn’t hold, a store it doesn’t hold all of, files it doesn’t hold the new bytes of.

Trait Implementations

impl Clone for SessionRecord

fn clone(&self) -> SessionRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionRecord

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

Formats the value using the given formatter.

impl Default for SessionRecord

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SessionRecord

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SessionRecord

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 SessionRecord