Struct SaveGame

pub struct SaveGame {
    pub name: String,
    pub path: PathBuf,
    pub difficulty: Option<Difficulty>,
    pub game_type: GameType,
    pub game_version: Option<String>,
    pub seed: Option<i64>,
    pub last_played: OffsetDateTime,
}

Available on crate feature save-games only.

Represents a single save game.

Fields

name: String

Name of the save game

path: PathBuf

Path to the save game

difficulty: Option<Difficulty>

Difficulty of the save game. No value means the difficulty is globally set (older versions).

game_type: GameType

Game type for new players

game_version: Option<String>

Game version the save game was last saved in

seed: Option<i64>

The seed of the save game

last_played: OffsetDateTime

Last played timestamp

Implementations

impl SaveGame

pub async fn export( &self, dest: impl AsRef<Path>, compression: u32, ) -> CobbleResult<()>

Available on crate feature backup only.

Exports the save game folder using a gzip compressed tar archive. The compression is a level is an integer from 0-9 where 0 means “no compression” and 9 means “take as long as you’d like”.

pub async fn import( saves_path: impl AsRef<Path>, src: impl AsRef<Path>, ) -> CobbleResult<Option<SaveGame>>

Available on crate feature backup only.

Imports a save game archive. The archive needs to contain the marker file. Validates the imported save game and returns None if the save game could not be parsed.

pub async fn remove(self) -> CobbleResult<()>

Removes the whole save game folder.

Warning: This will permanently delete the save game!

pub async fn icon(&self) -> CobbleResult<Option<Vec<u8>>>

Loads the icon from the save game.

pub fn icon_path(&self) -> PathBuf

Gets the path of the icon.png file.

Trait Implementations

impl Clone for SaveGame

fn clone(&self) -> SaveGame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SaveGame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SaveGame

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SaveGame

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

where __S: Serializer,

Serialize this value into the given Serde serializer.