Struct butlerd::Butler[][src]

pub struct Butler { /* fields omitted */ }

Represents a connection to a butlerd instance

Methods

impl Butler
[src]

Initializes a new butlerd instance. It will close when your program does.

Shuts down butler daemon.

Fetchs all installed caves

Fetches specific game by id

Fetches specific cave by id

Makes a cave 'pinned' or not depending on pinned

Launches game by CaveID. Note that this will not complete until the game is closed.

Lists saved profiles

Sets a specific profile info value

Searches for folders possible to clean

Cleans specified CleanDownloadsEntries

Gets a specific profile info value

Removes a profile's saved info. Also removes it from profile_list. Returns true if successful.

Disables updates for a cave

Logs into a profile using saved credentials

Given an API key, logs into a profile and returns profile.

Given an username and password, logs into a profile and returns profile and cookie. May fail if a captcha or 2factor is required. Working on fix.

Fetches all common/cached items and returns summaries

Fetches a vec of games owned by a specific profile id

Fetches download key

Fetches collection info. Does not include games

Fetches all collections for a profile. Does not include games

Fetches games in a collection

Fetches owned download keys for a profile. Pass fresh as true to force butler to refresh cache

Marks all local data as 'stale' and outdated

Searches users

Sets a throttle for how much bandwith butler can use. If enabled is false, disables any previous set throttles. Rate is measured in kbps

Fetches the best available sale for a game(if such a sale exists)

Gets all configured butler install locations in a vec

Gets info on a filesystem

Checks if an update is available for a vec of Caves. If you pass an empty vec, all caves will be checked.

Cancels an install. Needs an install id. Result is true if cancel succeeded

Queues up a game installation

Performs an Install. Download must be completed beforehand

Fetches all uploads for a game

Queues a download to later be downloaded by downloads_drive

Downloads all games in the queue. Completes when they are all done

Cancels driving downloads. Returns bool indicating success.

Forces butler's online/offline state. True is offline, False is online

Discards one download

Prioritizes by download id

Retries an errored download id

Gets butler version strings

Clears all completed downloads from the queue

A helper function that performs all of the game installation/download steps for you. Recommended over doing installation yourself.

Fetches a vec of Downloads from the queue, returning a BError if none are available

Searches games for string. Requires profileid.

Adds a new install location

Removes an install location

Gets an install location from a previously fetched id

Uninstalls a cave

Auto Trait Implementations

impl Send for Butler

impl Sync for Butler