static-metric/src/builder: Allow non-public label enums #355
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Imagine the following static metric generation:
```rust
make_static_metric! {
label_enum Methods {
post,
get,
}
struct MyStaticCounterVec: Counter {
"method" => Methods,
}
}
```
This will roughly expand to:
```rust
enum Methods {
post,
get,
}
use self::prometheus_static_scope_0::MyStaticCounterVec;
mod prometheus_static_scope_0 {
pub struct MyStaticCounterVec {
pub post: MyStaticCounterVec2,
pub get: MyStaticCounterVec2,
}
}
```
Rustc would complain that the `private type 'Methods' [is] in [the]
public interface (error E0446)` `MyStaticCounterVec`.
There is no reason for `MyStaticCounterVec` to be defined with
visibility `pub`. This commit instead defines `MyStaticCounterVec` with
`pub(super)` and thus `MyStaticCounterVec` does not expose the private
type `Methods`.
Signed-off-by: Max Inden <[email protected]>
|
Maybe supplying some tests that will pass compile in this PR but will fail in master would be better! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Imagine the following static metric generation:
This will roughly expand to:
Rustc would complain that the
private type 'Methods' [is] in [the] public interface (error E0446)MyStaticCounterVec.There is no reason for
MyStaticCounterVecto be defined withvisibility
pub. This commit instead definesMyStaticCounterVecwithpub(super)and thusMyStaticCounterVecdoes not expose the privatetype
Methods.Signed-off-by: Max Inden [email protected]