summaryrefslogtreecommitdiffstats
path: root/src/tools/cargo/crates/crates-io/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/cargo/crates/crates-io/lib.rs')
-rw-r--r--src/tools/cargo/crates/crates-io/lib.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/tools/cargo/crates/crates-io/lib.rs b/src/tools/cargo/crates/crates-io/lib.rs
index 757241fd3..1764ce527 100644
--- a/src/tools/cargo/crates/crates-io/lib.rs
+++ b/src/tools/cargo/crates/crates-io/lib.rs
@@ -38,6 +38,10 @@ pub struct Crate {
pub max_version: String,
}
+/// This struct is serialized as JSON and sent as metadata ahead of the crate
+/// tarball when publishing crates to a crate registry like crates.io.
+///
+/// see <https://doc.rust-lang.org/cargo/reference/registry-web-api.html#publish>
#[derive(Serialize, Deserialize)]
pub struct NewCrate {
pub name: String,