Trait primitives::prelude::Session

pub trait Session {
    fn id(&self) -> String;
    fn is_tester(&self) -> bool;
    fn clone(&self, new_id: String) -> Box<dyn Session>;
    fn reset(&self, is_saved: Option<bool>);
    fn save(&self);
    fn delete(&self);
    fn percentage_complete(&self) -> f32;
    fn get_session_ids(&self, suggestions: Option<Vec<String>>) -> Vec<String>;
    fn get_sessions(&self, suggestions: Option<Vec<String>>) -> Vec<String>;
    fn delete_all_sessions(&self);
}

The Session should be implemented by objects wishing to preserve interactive information interchange.

The session can be used as both memento and arbitrator between subsystems - including entities and scenes. Sessions can be permanently stored and retrieved on future application ezecution.

Required Methods

fn id(&self) -> String

The unique identifier of this session.

fn is_tester(&self) -> bool

Useful for testing and debug.

fn clone(&self, new_id: String) -> Box<dyn Session>

Creates a copy of the current session.

Arguments

• newId - The unique identifier of the copy.

Return: A copy of the current session.

fn reset(&self, is_saved: Option<bool>)

Reverts the session back to factory settings (as if created afresh).

Arguments

• isSaved - If true immediately writes the reset session to disk. (optional, default: false)

fn save(&self)

Writes the session to disk.

fn delete(&self)

Removes the session from disk.

fn percentage_complete(&self) -> f32

Helper functio’n to calculate overall progress of a game / rewards acquired etc.

Return: Range 0…1: with 1 representing complete.

fn get_session_ids(&self, suggestions: Option<Vec<String>>) -> Vec<String>

Retrieve the collection of sessions identifiers currently saved to disk.

Arguments

• suggestions - Prepopulates results with the suggestions. (optional)

Return: A collection of sessions identifiers currently save to disk.

fn get_sessions(&self, suggestions: Option<Vec<String>>) -> Vec<String>

Retrieve the collection of sessions currently saved to disk.

Arguments

• suggestions - Prepopulates results with the suggestions. (optional)

Return: A collection of sessions currently save to disk.

fn delete_all_sessions(&self)

Removes all session data from disk.

Implementors