Struct SteamWorkshop

pub struct SteamWorkshop { /* private fields */ }

Implementations

impl SteamWorkshop

pub fn new() -> SteamWorkshop

Creates a new workshop instance, client will be auto created if None

pub fn new_with_client(client: Client) -> SteamWorkshop

pub fn set_apikey(&mut self, apikey: Option<String>)

Gets an authorized workshop, allows access to methods that require api keys. Get api keys from https://steamcommunity.com/dev/apikey

pub fn set_proxy_domain(&mut self, proxy_domain: Option<String>)

Will change the domain that requests are made to, allowing you to proxy api.steampowered.com

pub fn get_vpks_in_folder(dir: &Path) -> Result<Vec<DirEntry>, String>

Returns DirEntry for all *.vpk files in a directory.

pub fn get_published_file_details( &self, fileids: &[String], ) -> Result<Vec<WorkshopItem>, Error>

Fetches the latest WorkshopItem per each addon id Steam API only allows 100 entries at once, will have an api error if more given

pub fn get_collection_details( &self, fileid: &str, ) -> Result<Option<Vec<String>>, Error>

Gets the collection details (all the children of this item). Returns a list of children fileids which can be sent directly to get_published_file_details() Will return Ok(None) if the item is not a collection.

pub fn search_items( &self, options: &SearchOptions, ) -> Result<SearchResult, Error>

Searches for workshop items, returns their file ids. REQUIRES steam apikey or a proxy domain

pub fn can_subscribe(&self, publishedfileid: &str) -> Result<bool, Error>

Check if the user (of apikey) can subscribe to the published file REQUIRES apikey, cannot use proxy.

pub fn subscribe( &self, publishedfileid: &str, include_dependencies: bool, ) -> Result<(), Error>

Makes the user (of apikey) subscribe to item. REQUIRES apikey, cannot use proxy.

Arguments

• include_dependencies - If true, will automatically subscribe to all dependencies of given id

pub fn unsubscribe(&self, publishedfileid: &str) -> Result<(), Error>

Makes the user (of apikey) unsubscribe from an item. REQUIRES apikey, cannot use proxy.

Trait Implementations

impl Clone for SteamWorkshop

fn clone(&self) -> SteamWorkshop

Returns a duplicate of the value.

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

Performs copy-assignment from source.