Struct PackageInfo 

pub struct PackageInfo {
    pub directory: String,
    pub name: String,
    pub version: String,
    pub size: u64,
    pub sha256: String,
    pub updated_at: i64,
    pub game: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub exclusive_group: Option<String>,
    pub requires: Vec<String>,
}

One installable package as listed by GET /packages.

Fields

directory: String

The access directory, [a-z0-9_-]+.

name: String

The path under directory without .zip, e.g. codriver/polish/male/Kamil. A lookup key: check it with valid_name, never join it onto a filesystem path.

version: String

size: u64

Bytes in the zip.

sha256: String

Lowercase hex sha256 of the zip, which the installer verifies after downloading.

updated_at: i64

Unix seconds.

game: String

One of GAME_*.

display_name: Option<String>

Renames the leaf only; the levels above it always come from name.

description: Option<String>

exclusive_group: Option<String>

Packages in one group overwrite the same files, so at most one of them is installed.

requires: Vec<String>

PackageRefs in their directory/name text form.

Implementations

impl PackageInfo

pub fn is_public(&self) -> bool

pub fn package_ref(&self) -> PackageRef

pub fn segments(&self) -> Split<'_, char>

pub fn category(&self) -> &str

The first segment; a name without a / is its own category.

pub fn tree_levels(&self) -> Vec<&str>

The segments between the category and the leaf; empty for style/Descriptive.

pub fn leaf(&self) -> &str

pub fn label(&self) -> &str

display_name when set, otherwise the leaf, never the whole path.

pub fn download_path(&self) -> String

The tail of GET /download/<game>/<directory>/<name>.

pub fn requires_ref(&self, reference: &PackageRef) -> bool

pub fn required_refs(&self) -> Vec<PackageRef>

Drops malformed entries, which manifest gen already warned the publisher about.

Trait Implementations

impl Clone for PackageInfo

fn clone(&self) -> PackageInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PackageInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.