Implement a lint for the use of private types in exported type signatures#12595

huonw · 2014-02-27T08:14:19Z

These are types that are in exported type signatures, but are not
exported themselves, e.g.

struct Foo { ... }

pub fn bar() -> Foo { ... }

will warn about the Foo.

Such types are not listed in documentation, and cannot be named outside
the crate in which they are declared, which is very user-unfriendly.

cc #10573.

huonw · 2014-02-27T08:14:51Z

r? @alexcrichton

A long delayed reimplementation of #11773.

alexcrichton · 2014-02-27T09:06:52Z

This is some good work, nice job! Most of my comments are just small things here and there, I think that we'll get a lot of good use cases for this lint once landed because it's warn-by-default.

Travis also has some failures you may be interested in.

huonw · 2014-02-27T12:11:56Z

Added a new commit addressing everything. Will squash post-re-review.

alexcrichton · 2014-02-27T18:33:41Z

r=me, nice job!

These are types that are in exported type signatures, but are not exported themselves, e.g. struct Foo { ... } pub fn bar() -> Foo { ... } will warn about the Foo. Such types are not listed in documentation, and cannot be named outside the crate in which they are declared, which is very user-unfriendly. cc rust-lang#10573

The sync submodule also has a `Condvar` type, and its reexport was shadowing the `arc` type, making it crate-private.

…laces. There's a lot of these types in the compiler libraries, and a few of the older or private stdlib ones. Some types are obviously meant to be public, others not so much.

These are types that are in exported type signatures, but are not exported themselves, e.g. struct Foo { ... } pub fn bar() -> Foo { ... } will warn about the Foo. Such types are not listed in documentation, and cannot be named outside the crate in which they are declared, which is very user-unfriendly. cc #10573.

Modify lint pass note for consistency with the book This PR: - removes the note which appears when an early lint pass is created using `cargo dev new_lint`. - adds a note that encourages contributors to use an early pass unless type information is needed if a late lint pass is created using `cargo dev new_lint`. Late pass remains the default value if no pass is specified as most lints use late pass. Closes rust-lang#12595 changelog: none

huonw added 3 commits March 1, 2014 00:11

sync: Rename arc::Condvar to arc::ArcCondvar.

fbdd3b2

The sync submodule also has a `Condvar` type, and its reexport was shadowing the `arc` type, making it crate-private.

Publicise types/add #[allow(visible_private_types)] to a variety of p…

218eae0

…laces. There's a lot of these types in the compiler libraries, and a few of the older or private stdlib ones. Some types are obviously meant to be public, others not so much.

bors closed this Feb 28, 2014

bors merged commit 218eae0 into rust-lang:master Feb 28, 2014

huonw mentioned this pull request Mar 1, 2014

Refine the story of externally referenced private structures. #10573

Closed

huonw deleted the pub-vis-typ branch June 27, 2014 06:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implement a lint for the use of private types in exported type signatures#12595