Struct steamlocate::SteamDir

pub struct SteamDir {
    pub path: PathBuf,
    /* private fields */
}

An instance of a Steam installation.

All functions of this struct will cache their results.

If you’d like to dispose of the cache or get uncached results, just instantiate a new SteamDir.

Example

let steamdir = SteamDir::locate();
println!("{:#?}", steamdir.unwrap());

SteamDir (
    path: "C:\\Program Files (x86)\\Steam"
)

Fields

path: PathBuf

The path to the Steam installation directory on this computer.

Example: C:\Program Files (x86)\Steam

Implementations

impl SteamDir

pub fn libraryfolders(&mut self) -> &LibraryFolders

Returns a reference to a LibraryFolders instance.

You can then index LibraryFolders.paths to get a reference to a Vec<PathBuf> of every library folder installed on the file system.

This function will cache its result.

pub fn apps(&mut self) -> &HashMap<u32, Option<SteamApp>>

Returns a reference to HashMap<u32, Option<SteamApp>> of all SteamApps located on this computer.

All Option<SteamApp>s in this context will be Some, so you can safely unwrap() them without panicking.

This function will cache its results and will always return a reference to the same HashMap.

Example

let mut steamdir = SteamDir::locate().unwrap();
let apps: &HashMap<u32, Option<SteamApp>> = steamdir.apps();
println!("{:#?}", apps);

{
    4000: SteamApp (
        appid: u32: 4000,
        path: PathBuf: "C:\\Program Files (x86)\\steamapps\\common\\GarrysMod",
        vdf: <steamy_vdf::Table>,
        name: Some(String: "Garry's Mod"),
        last_user: Some(u64: 76561198040894045) // This will be a steamid_ng::SteamID if the "steamid_ng" feature is enabled
    )
    ...
}

pub fn app(&mut self, app_id: &u32) -> Option<&SteamApp>

Returns a Some reference to a SteamApp via its app ID.

If the Steam app is not installed on the system, this will return None.

This function will cache its (either Some and None) result and will always return a reference to the same SteamApp.

Example

let mut steamdir = SteamDir::locate().unwrap();
let gmod = steamdir.app(&4000);
println!("{:#?}", gmod.unwrap());

SteamApp (
    appid: u32: 4000,
    path: PathBuf: "C:\\Program Files (x86)\\steamapps\\common\\GarrysMod",
    vdf: <steamy_vdf::Table>,
    name: Some(String: "Garry's Mod"),
    last_user: Some(u64: 76561198040894045) // This will be a steamid_ng::SteamID if the "steamid_ng" feature is enabled
)

pub fn compat_tool(&mut self, app_id: &u32) -> Option<&SteamCompat>

Returns a Some reference to a SteamCompat via its app ID.

If no compatibility tool is configured for the app, this will return None.

This function will cache its (either Some and None) result and will always return a reference to the same SteamCompat.

pub fn shortcuts(&mut self) -> &[Shortcut]

Returns a listing of all added non-Steam games

Examples found in repository

examples/shortcuts.rs (line 5)

fn main() {
    let mut steamdir = steamlocate::SteamDir::locate().unwrap();
    let shortcuts = steamdir.shortcuts();
    println!("Shortcuts - {:#?}", shortcuts);
}

pub fn locate() -> Option<SteamDir>

Locates the Steam installation directory on the filesystem and initializes a SteamDir (Linux)

Returns None if no Steam installation can be located.

Examples found in repository

examples/shortcuts.rs (line 4)

fn main() {
    let mut steamdir = steamlocate::SteamDir::locate().unwrap();
    let shortcuts = steamdir.shortcuts();
    println!("Shortcuts - {:#?}", shortcuts);
}

Trait Implementations

impl Clone for SteamDir

fn clone(&self) -> SteamDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SteamDir

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

Formats the value using the given formatter.

impl Default for SteamDir

fn default() -> SteamDir

Returns the “default value” for a type.