-
Notifications
You must be signed in to change notification settings - Fork 12.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
privacy: Substitute type aliases in private-in-public checker #34193
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
b7db9e8
privacy: Substitute type aliases in private-in-public checker
petrochenkov 08f0f7c
Substitute private type aliases in rustdoc
petrochenkov d43b9cb
privacy: Move private-in-public diagnostics for type aliases to the p…
petrochenkov 5d4ae4b
Add test for recursive private alias substitution in rustdoc
petrochenkov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -105,8 +105,6 @@ mod aliases_pub { | |
} | ||
impl PrivTr for Priv {} | ||
|
||
// This should be OK, if type aliases are substituted | ||
pub fn f2(arg: PrivAlias) {} //~ ERROR private type in public interface | ||
// This should be OK, but associated type aliases are not substituted yet | ||
pub fn f3(arg: <Priv as PrivTr>::AssocAlias) {} //~ ERROR private type in public interface | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can we add a test to show that no error results? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's tested, the check is just moved from this file to |
||
|
||
|
@@ -143,8 +141,6 @@ mod aliases_params { | |
type PrivAliasGeneric<T = Priv> = T; | ||
type Result<T> = ::std::result::Result<T, Priv>; | ||
|
||
// This should be OK, if type aliases are substituted | ||
pub fn f1(arg: PrivAliasGeneric<u8>) {} //~ ERROR private type in public interface | ||
pub fn f2(arg: PrivAliasGeneric) {} //~ ERROR private type in public interface | ||
pub fn f3(arg: Result<u8>) {} //~ ERROR private type in public interface | ||
} | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT | ||
// file at the top-level directory of this distribution and at | ||
// http://rust-lang.org/COPYRIGHT. | ||
// | ||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or | ||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license | ||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your | ||
// option. This file may not be copied, modified, or distributed | ||
// except according to those terms. | ||
|
||
type MyResultPriv<T> = Result<T, u16>; | ||
pub type MyResultPub<T> = Result<T, u64>; | ||
|
||
// @has private_type_alias/fn.get_result_priv.html '//pre' 'Result<u8, u16>' | ||
pub fn get_result_priv() -> MyResultPriv<u8> { | ||
panic!(); | ||
} | ||
|
||
// @has private_type_alias/fn.get_result_pub.html '//pre' 'MyResultPub<u32>' | ||
pub fn get_result_pub() -> MyResultPub<u32> { | ||
panic!(); | ||
} | ||
|
||
pub type PubRecursive = u16; | ||
type PrivRecursive3 = u8; | ||
type PrivRecursive2 = PubRecursive; | ||
type PrivRecursive1 = PrivRecursive3; | ||
|
||
// PrivRecursive1 is expanded twice and stops at u8 | ||
// PrivRecursive2 is expanded once and stops at public type alias PubRecursive | ||
// @has private_type_alias/fn.get_result_recursive.html '//pre' '(u8, PubRecursive)' | ||
pub fn get_result_recursive() -> (PrivRecursive1, PrivRecursive2) { | ||
panic!(); | ||
} | ||
|
||
type MyLifetimePriv<'a> = &'a isize; | ||
|
||
// @has private_type_alias/fn.get_lifetime_priv.html '//pre' "&'static isize" | ||
pub fn get_lifetime_priv() -> MyLifetimePriv<'static> { | ||
panic!(); | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will this logic work if you have a private type alias that refers to another private type alias?
e.g.,
type A = u32; type B = A; fn foo(x: B) { }
?(Can you also add some tests for that scenario? I could imagine that even if your patch gets it right, it's something future patches might easily break.)