Struct steam_tui::client::Client

pub struct Client { /* fields omitted */ }

Manages and interfaces with SteamCmd threads.

Implementations

impl Client

pub fn new() -> Client

Spawns a StemCmd process to interface with.

pub fn is_logged_in(&self) -> Result<bool, STError>

Ensures State is State::LoggedIn.

pub fn get_state(&self) -> Result<State, STError>

pub fn install(&self, id: i32) -> Result<(), STError>

Runs installation script for the provided game id.

pub fn restart(&self) -> Result<(), STError>

Quits previous SteamCmd instance, and spawns a new one. This can be useful for getting more state data. Old processes fail to update due to short comings in SteamCmd.

pub fn run(&self, id: i32, launchables: &[Launch]) -> Result<(), STError>

Launches the provided game id using ‘app_run’ in steemcmd, or the raw executable depending on the Steam client state.

pub fn login(&self, user: &str) -> Result<(), STError>

Attempts to login the provided user string.

pub fn load_games(&self) -> Result<(), STError>

Starts off the process of parsing all games from SteamCmd. First State is set to be in an unloaded state for State::Loaded. The process start by calling ‘licenses_print’ which then extracts packageIDs, and calls ‘package_info_print’ for each package. This in turn extracts appIDs, and gets app particular data by calling ‘app_info_print’ and binds it to a Game object. When all data is loaded, the games are dumped to a file and the state is changed to State::LoggedIn indicating that all data has been extracted and can be presented. TODO(#8): Check for cached games prior to reloading everything, unless explicitly restarted.

pub fn games(&self) -> Result<Vec<Game>, STError>

Extracts games from cached location.

pub fn status(&self, id: i32) -> Result<GameStatus, STError>

Binds data from ‘app_status’ to a GameStatus object.

pub fn start_client(&self) -> Result<(), STError>

Started up a headless steam instance in the background so that games can be launched through steamcmd.

Trait Implementations

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.