Struct modio::mods::ModRef

pub struct ModRef { /* private fields */ }

Reference interface of a mod.

Implementations

impl ModRef

pub async fn get(self) -> Result<Mod>

Get a reference to the Modio mod object that this ModRef refers to.

pub fn files(&self) -> Files

Return a reference to an interface that provides access to the files of a mod.

pub fn file(&self, id: FileId) -> FileRef

Return a reference to a file of a mod.

pub fn metadata(&self) -> Metadata

Return a reference to an interface to manage metadata key value pairs of a mod.

pub fn tags(&self) -> Tags

Return a reference to an interface to manage the tags of a mod.

pub fn comments(&self) -> Comments

Return a reference to an interface that provides access to the comments of a mod.

pub fn dependencies(&self) -> Dependencies

Return a reference to an interface to manage the dependencies of a mod.

pub async fn statistics(self) -> Result<Statistics>

Return the statistics for a mod.

pub fn events(self, filter: Filter) -> Query<Event>

Returns a Query interface to retrieve the event log for a mod sorted by latest event first.

See Filters and sorting.

pub fn members(&self) -> Members

Return a reference to an interface to manage team members of a mod.

pub async fn edit(self, options: EditModOptions) -> Result<Editing<Mod>>

Edit details for a mod. [required: token]

pub async fn delete(self) -> Result<()>

Delete a mod. [required: token]

pub async fn add_media(self, options: AddMediaOptions) -> Result<()>

Add new media to a mod. [required: token]

pub async fn delete_media(self, options: DeleteMediaOptions) -> Result<Deletion>

Delete media from a mod. [required: token]

pub async fn reorder_media(self, options: ReorderMediaOptions) -> Result<()>

Reorder images, sketchfab or youtube links from a mod profile. [required: token]

pub async fn rate(self, rating: Rating) -> Result<()>

Submit a positive or negative rating for a mod. [required: token]

pub async fn subscribe(self) -> Result<()>

Subscribe the authenticated user to a mod. [required: token]

pub async fn unsubscribe(self) -> Result<()>

Unsubscribe the authenticated user from a mod. [required: token]

Trait Implementations

impl Clone for ModRef

fn clone(&self) -> ModRef

Returns a copy of the value.

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

Performs copy-assignment from source.