SemverQuery(
id: "enum_repr_int_changed",
human_readable_name: "enum repr(u*)/repr(i*) changed",
description: "An enum's repr attribute changed integer types.",
reference: Some("The repr(u*) or repr(i*) attribute on an enum was changed to another integer type. This can cause its memory representation to change, breaking FFI use cases."),
required_update: Major,
// TODO: Change the reference link to point to the cargo semver reference
// once it has a section on repr(u*)/repr(i*).
reference_link: Some("https://doc.rust-lang.org/nomicon/other-reprs.html#repru-repri"),
query: r#"
{
CrateDiff {
baseline {
item {
... on Enum {
visibility_limit @filter(op: "=", value: ["$public"]) @output
name @tag @output
attribute {
attr_value: value @filter(op: "regex", value: ["$repr_regex"])
@tag @output(name: "old_attr")
}
importable_path {
path @tag @output
}
}
}
}
current {
item {
... on Enum {
visibility_limit @filter(op: "=", value: ["$public"])
name @filter(op: "=", value: ["%name"])
importable_path {
path @filter(op: "=", value: ["%path"])
}
# Check that there exists an attribute that:
# - looks like repr(i*) or repr(u*)
# - but is not the same repr(i*) or repr(u*) that we had before.
# This is the breaking change.
attribute @fold @transform(op: "count") @filter(op: ">", value: ["$zero"]) {
value @filter(op: "regex", value: ["$repr_regex"])
@filter(op: "!=", value: ["%attr_value"])
@output(name: "new_attr")
}
span_: span @optional {
filename @output
begin_line @output
}
}
}
}
}
}"#,
arguments: {
"public": "public",
"repr_regex": "#\\[repr\\([ui]\\d+|size\\)\\]",
"zero": 0,
},
error_message: "The repr(u*) or repr(i*) attribute on an enum was changed to another integer type. This can cause its memory representation to change, breaking FFI use cases.",
per_result_error_template: Some("enum {{name}} {{old_attr}} -> {{new_attr.0}} in {{span_filename}}:{{span_begin_line}}"),
)