Struct physis::repository::Repository

pub struct Repository {
    pub name: String,
    pub platform: Platform,
    pub repo_type: RepositoryType,
    pub version: Option<String>,
}

Encapsulates a directory of game data, such as “ex1”. This data is also versioned. This handles calculating the correct dat and index filenames, mainly for GameData.

Fields

name: String

The folder name, such as “ex1”.

platform: Platform

The platform this repository is designed for.

repo_type: RepositoryType

The type of repository, such as “base game” or “expansion”.

version: Option<String>

The version of the game data.

Implementations

impl Repository

pub fn from_existing_base(platform: Platform, dir: &str) -> Option<Repository>

Creates a new base Repository, from an existing directory. This may return None if the directory is invalid, e.g. a version file is missing.

pub fn from_existing_expansion( platform: Platform, dir: &str, ) -> Option<Repository>

Creates a new expansion Repository, from an existing directory. This may return None if the directory is invalid, e.g. a version file is missing.

pub fn index_filename(&self, chunk: u8, category: Category) -> String

Calculate an index filename for a specific category, like “0a0000.win32.index”.

pub fn index2_filename(&self, chunk: u8, category: Category) -> String

Calculate an index2 filename for a specific category, like “0a0000.win32.index”.

pub fn dat_filename( &self, chunk: u8, category: Category, data_file_id: u32, ) -> String

Calculate a dat filename given a category and a data file id, returns something like “0a0000.win32.dat0”.

Trait Implementations

impl Clone for Repository

fn clone(&self) -> Repository

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Repository

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

Formats the value using the given formatter.

impl Ord for Repository

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Repository

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Repository

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Repository