feat(cargo-util-schemas): Move lockfile schemas #15980
Conversation
rustbot
added
A-dependency-resolution
Some of the fields are made public to make the moving phase easier. They will be reverted back to private when its done moving over.
simplifies the moving over of the schemas
secona
force-pushed
the
lockfile-schemas
branch
from
187383c to
949e863
Compare
Manifests schemas use `TomlManifest`. To match, we rename the lockfile schemas to `TomlLockfile`
rustbot
removed
the
S-waiting-on-review
| impl FromStr for TomlLockfilePackageId { | ||
| type Err = EncodablePackageIdError; | ||
|
|
||
| fn from_str(s: &str) -> Result<TomlLockfilePackageId, Self::Err> { |
There was a problem hiding this comment.
This parses the v1 lockfile representation for backfilling ckechsums purpose. Should we make it private and add comment around otherwise it gives a false sense if this is how we parse package id.
More like an documentation issue though.
| } | ||
|
|
||
| impl TomlLockfileSourceId { | ||
| pub fn new(source: String) -> Result<Self, EncodableSourceIdError> { |
There was a problem hiding this comment.
Do we expect user to create SourceId from raw strings?
I know the API is pub because libcargo needs it, but I fee like this may expose an implicit dependency of the shape of source id string, which should be opaque according to our current documentation.
Changing the underlying implmemtation won't be SemVer breaking, but it may break tools relying on it and narrow their supported Rust toolchain versions if using this API.
Anyway, this is all hypothetical.
There was a problem hiding this comment.
In cargo plumbing, we use this to parse the source ID generated by cargo, i.e. from dependency resolution results and lockfiles. I imagine users would do the same.
### What does this PR try to resolve? Add documentation efforts to the lockfile schemas. Continuation of #15980 ### How to test and review this PR?
What does this PR try to resolve?
As part of cargo plumbing commands, we're trying to make lockfiles more accessible to third-party uses. This change moves the lockfile schemas to
cargo-util-schemas, where it is previously undercargoand are relatively hidden.See also: crate-ci/cargo-plumbing#82
How to test and review this PR?
Commit by commit to see the changes made. My main concern is performance as the implementation repeatedly calls
SourceId::from_urland I'm not sure if its negligible.r? @epage