Skip to content
This repository was archived by the owner on Jun 13, 2025. It is now read-only.

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 24, 2025

Bumps steamlocate from 2.0.0-beta.2 to 2.0.1.

Release notes

Sourced from steamlocate's releases.

2.0.1

Just a small release to keep things up to date

Documentation

  • Add a changelog #89

Dependencies

  • Update winreg from 0.52 -> 0.55 #86

Internal

  • Make tests into into integration tests where possible #87
  • Remove publish workflow #88
  • Add a release checklist #90

2.0.0 Release - Major API Overhaul

Finally after a very long development period we're release version 2.0.0. Living up to the major version bump this release does involve breaking changes to most parts of the API. The majority of these changes fit into three core themes:

  1. Iteratorification of the list all flavors of methods
  2. Exhaustively parsing Apps (previously SteamApps) to drop the public dependency on steamy-vdf
  3. Actually defining an Error type instead of returning ambiguous Nones

Let's dive right in

Iteratorification of the list all methods

Methods that would previously exhaustively collect some set of information and cache it like SteamDir::libraryfolders() and SteamDir::apps() now return iterators that walk over the set of information and returns values on the fly akin to APIs like std::fs::read_dir(). This has a couple of distinct advantages where we can return precise errors for each item ergonomically, and we can be lazier with our computation

Exhaustive Apps

We're trying to be a stable library since our major version is >0, but unfortunately there's not a stable VDF parser in sight. That's a bit problematic as we'll want to avoid relying on one in our public API, but that also means significant changes to how App would hold a steamy_vdf::Table representing the parsed appmanifest file. To mitigate this we attempt to exhaustively parse and provide as much data as we can from steam apps, and to top it off we also annotated it with #[non_exhaustive], so that more fields can be added in the future without a breaking change

An Error appears!

This is a significant improvement over the old API. Previously errors would be bubbled up as Nones that would lead to ambiguity over whether a None is from something not existing or simply failing to be parsed. We now religiously return errors to represent failure cases leaving it up to the consumer to decide whether to ignore the error or fail loudly

Where possible we try to include relevant information for the error, but several of the underlying types are intentionally opaque to avoid exposing unstable depdencies in our public API

Changelog

Sourced from steamlocate's changelog.

2.0.1

Just a small release to keep things up to date

Documentation

  • Add a changelog #89

Dependencies

  • Update winreg from 0.52 -> 0.55 #86

Internal

  • Make tests into into integration tests where possible #87
  • Remove publish workflow #88
  • Add a release checklist #90

2.0.0

Finally after a very long development period we're release version 2.0.0. Living up to the major version bump this release does involve breaking changes to most parts of the API. The majority of these changes fit into three core themes:

  1. Iteratorification of the list all flavors of methods
  2. Exhaustively parsing Apps (previously SteamApps) to drop the public dependency on steamy-vdf
  3. Actually defining an Error type instead of returning ambiguous Nones

Let's dive right in

Iteratorification of the list all methods

Methods that would previously exhaustively collect some set of information and cache it like SteamDir::libraryfolders() and SteamDir::apps() now return iterators that walk over the set of information and returns values on the fly akin to APIs like std::fs::read_dir(). This has a couple of distinct advantages where we can return precise errors for each item ergonomically, and we can be lazier with our computation

Exhaustive Apps

We're trying to be a stable library since our major version is >0, but unfortunately there's not a stable VDF parser in sight. That's a bit problematic as we'll want to avoid relying on one in our public API, but that also means significant changes to how App would hold a steamy_vdf::Table representing the parsed appmanifest file. To mitigate this we attempt to exhaustively parse and provide as much data as we can from steam apps, and to top it off we also annotated it with #[non_exhaustive], so that more fields can be added in the future without a breaking change

An Error appears!

This is a significant improvement over the old API. Previously errors would be bubbled up as Nones that would lead to ambiguity over whether a None is from something not existing or simply failing to be parsed. We now religiously return errors to represent failure cases leaving it up to the consumer to decide whether to ignore the error or fail loudly

Where possible we try to include relevant information for the error, but several of the underlying types are intentionally opaque to avoid exposing unstable depdencies in our public API

Commits

Dependabot compatibility score

You can trigger a rebase of this PR by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

Bumps [steamlocate](https://github.com/WilliamVenner/steamlocate-rs) from 2.0.0-beta.2 to 2.0.1.
- [Release notes](https://github.com/WilliamVenner/steamlocate-rs/releases)
- [Changelog](https://github.com/WilliamVenner/steamlocate-rs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/WilliamVenner/steamlocate-rs/commits/2.0.1)

---
updated-dependencies:
- dependency-name: steamlocate
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file rust Pull requests that update Rust code labels Feb 24, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

dependencies Pull requests that update a dependency file rust Pull requests that update Rust code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant