Struct File

pub struct File { /* private fields */ }

Represents a valid Darkest Dungeon save file.

See the main library docs for usage examples.

A note on binary file identity

Files produced by the game currently contain unidentified bits. Right now, if you read a binary file and encode it to binary again, you will encounter some different bits. Theoretically, sizes could be different due to data alignment, though this has not been observed in practice yet. Phrased differently, the Binary => File conversion is minimally lossy. File => Binary and File <=> JSON conversions are lossless.

It is recommended that tools operating on the JSON representation preserve the order of fields in the file.

Implementations

impl File

pub fn try_from_bin<R: Read>(reader: &mut R) -> Result<Self, FromBinError>

Attempt create a Darkest Dungeon save File from a Read representing a binary encoded file.

pub fn write_to_bin<W: Write>(&self, writer: &mut W) -> Result<()>

Write this File as Binary.

impl File

pub fn try_from_json<R: Read>(reader: &mut R) -> Result<Self, FromJsonError>

Attempt to decode a File from a Read representing a JSON stream.

pub fn write_to_json<T: AsRef<str>, W: Write>( &self, writer: &mut W, allow_dupes: bool, unhash: &Unhasher<T>, ) -> Result<()>

Write this File as JSON.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl PartialEq for File

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for File