Where did gix::worktree::checkout go in gix 0.52?

[Shnatsel]

cargo-audit uses gix::worktree::checkout from gix crate v0.51.x, here.

I am in the process of upgrading to gix 0.52, and I cannot find a checkout function in 0.52. I've searched docs.rs for "checkout" but there seemed to be no matching functions in 0.52. How can I perform checkouts in the latest release?

[niklaswimmer]

It seems like this functionality was split into a new crate: https://docs.rs/gix-worktree-state/latest/gix_worktree_state/

[Byron]

Sorry for the hassle. This is in preparation for compile time improvements, and now the method is available in gix::worktree::state::checkout().

[Shnatsel]

That worked. Thanks!

For some reason this method does not come up in search on docs.rs, you might want to look into that.

[Byron]

It seems that rustdoc doesn't index crates that are re-exported via pub use, and maybe that's good as it's a plumbing crate with a lower-level interface. At some point all of these should be moved behind an unstable flag if they are pre-1.0 as well.

In any case, I am glad it works now.

[Shnatsel]

The 0.51 function is indexed just fine: https://docs.rs/gix/0.51.0/gix/index.html?search=checkout

[Byron]

Can it be there is a difference between a top-level reexport (in gix) like this and one that is in gix::worktree? Apparently it is, and I wonder if it's intentional. I can click through to the checkout function too, it's just not listed in the search if re-exported from a sub-module.