Struct ajour_core::addon::Addon

pub struct Addon {
    pub primary_folder_id: String,
    pub folders: Vec<AddonFolder>,
    pub state: AddonState,
    pub release_channel: ReleaseChannel,
    // some fields omitted
}

Struct which stores information about a single Addon. This struct is enriched with metadata from the active repository for the addon. If there is no match to any repository, metadata will be used from the primary AddonFolder for this Addon.

Fields

primary_folder_id: String

Id of the AddonFolder that will serve as a fallback for metadata if no match to any Repository or if those fields don’t populate from the active repository API. Also serves as the unique identifier for this Addon.

When we match against Curse which has modules for bundling multiple folders into a single Addon, we use the first folder name alphabetically.

When matching against Tukui, we use the folder which has the Tukui project id

folders: Vec<AddonFolder>

All AddonFolder’s provided by this Addon

state: AddonState

release_channel: ReleaseChannel

Implementations

impl Addon

pub fn empty(primary_folder_id: &str) -> Self

pub fn set_repository(&mut self, repo_package: RepositoryPackage)

pub fn set_remote_package_from_repo_package(
    &mut self,
    repo_package: &RepositoryPackage
)

pub fn update_addon_folders(&mut self, folders: Vec<AddonFolder>)

pub fn repository(&self) -> Option<&RepositoryPackage>

pub fn repository_kind(&self) -> Option<RepositoryKind>

Returns the repository kind linked to this addon

pub fn version(&self) -> Option<&str>

Returns the version of the addon

pub fn set_version(&mut self, version: String)

Sets the version of the addon

pub fn set_file_id(&mut self, file_id: i64)

Sets the file id of the addon

pub fn title(&self) -> &str

Returns the title of the addon.

pub fn author(&self) -> Option<&str>

Returns the author of the addon.

pub fn game_version(&self) -> Option<&str>

Returns the game version of the addon.

pub fn notes(&self) -> Option<&str>

Returns the notes of the addon.

pub fn website_url(&self) -> Option<&str>

Returns the website url of the addon.

pub fn changelog_url(
    &self,
    default_release_channel: GlobalReleaseChannel
) -> Option<String>

Returns the changelog url of the addon.

pub async fn changelog(
    &self,
    default_release_channel: GlobalReleaseChannel
) -> Result<Changelog, RepositoryError>

pub fn curse_id(&self) -> Option<i32>

Returns the curse id of the addon, if applicable.

pub fn tukui_id(&self) -> Option<&str>

Returns the tukui id of the addon, if applicable.

pub fn wowi_id(&self) -> Option<&str>

Returns the wowi id of the addon, if applicable.

pub fn hub_id(&self) -> Option<i32>

Returns the hub id of the addon, if applicable.

pub fn remote_packages(&self) -> HashMap<ReleaseChannel, RemotePackage>

pub fn file_id(&self) -> Option<i64>

pub fn repository_id(&self) -> Option<&str>

Returns the repository id for the active repository

pub fn is_ignored(&self, ignored: Option<&Vec<String>>) -> bool

Function returns a bool indicating if the user has manually ignored the addon.

pub fn is_updatable(&self, remote_package: &RemotePackage) -> bool

Function returns a bool indicating if the remote_package is a update.

pub fn relevant_release_package(
    &self,
    default_release_channel: GlobalReleaseChannel
) -> Option<RemotePackage>

Returns the relevant release_package for the addon. Logic is that if a release channel above the selected is newer, we return that instead.

Trait Implementations

impl Clone for Addon

fn clone(&self) -> Addon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Addon

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

Formats the value using the given formatter.

impl Eq for Addon

impl Ord for Addon

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Addon> for Addon

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Addon> for Addon

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 TryFrom<&'_ Addon> for AddonCacheEntry

type Error = CacheError

The type returned in the event of a conversion error.

fn try_from(addon: &Addon) -> Result<Self, CacheError>

Performs the conversion.