Skip to content

Document fully-qualified syntax in as' keyword doc #142670

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

fpdotmonkey
Copy link

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Jun 18, 2025

r? @ibraheemdev

rustbot has assigned @ibraheemdev.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jun 18, 2025
@fpdotmonkey fpdotmonkey force-pushed the doc/as-fully-qualified-syntax branch from 7cfd0dd to a2d247b Compare June 18, 2025 13:32
/// _fully qualified path_, a means of clarifying ambiguous method calls, constants, and types.
/// If you have a type which implements two traits with identical method names (e.g.
/// `Into<u32>::into` and `Into<u64>::into`), you can clarify which method you'll use with
/// `<MyThing as Into<u32>>::into(my_thing)`. This is quite verbose, but fortunately, Rust's type
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any other std traits where this is commonly needed? A small downside with this example is that this is something that should just be written u32::from(my_thing) 🙂

Copy link
Author

@fpdotmonkey fpdotmonkey Jun 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be a thing with Debug vs Display::fmt. That said, <Self as fmt::Debug>::fmt(self, f) is semantically identical, longer, and weirder than fmt::Debug::fmt(self, f). io::Write::write_fmt and fmt::Write::write_fmt have the same problem.

Into<T> is nice since it's reasonably likely that users will encounter a message from rustc that they should use the fully-qualified path as in these docs (though by all rights, it should suggest that you should use T::from(self)).

An other option would be to make a contrived exampled like is done in the Rust book. E.g.,

struct Person;

trait MetalHead {
    fn head_bang();
}
trait SalaryWorker {
    fn head_bang();
}
impl MetalHead for Person { ... }
impl SalaryWorker for Person { ... }

// 9 to 5
<Person as SalaryWorker>::head_bang();
// 5 to 9
<Person as MetalHead>::head_bang();

But of course coming up with a more useful example is hard since associated items don't usually overlap and there's usually sufficient type information to remove the ambiguity this doc is trying to highlight. The optimal example would be either a pair of trait methods that return a generic type like Into::<T>::into, or a pair of static trait methods. Short of what's here already, I can't find anything like that.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it so there's a footnote saying that it'd be better to use T::from(my_thing) and that the example is imperfect.

Comment on lines 28 to 29
/// _fully qualified path_, a means of clarifying ambiguous method calls, constants, and types.
/// If you have a type which implements two traits with identical method names (e.g.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small nit.

Suggested change
/// _fully qualified path_, a means of clarifying ambiguous method calls, constants, and types.
/// If you have a type which implements two traits with identical method names (e.g.
/// _fully qualified path_, a means of clarifying ambiguous associated items. For example,
/// if you have a type which implements two traits with identical method names (e.g.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to make this change, but isn't this a bit less useful? As it was, it tells you exactly which syntactic objects this syntax can be used with, whereas the change demands that you know about the associated item abstraction. Realistically, if I'm someone who's reading the keyword docs, I'm probably a rust beginner and probably not familiar with this abstraction.

Perhaps "a means of clarifying ambiguous associated items, i.e. methods, constants, and types. For example," would be a good compromise?

Copy link
Member

@fmease fmease Jun 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I'm not the primary reviewer) if you end up listing the three kinds of associated item, please substitute method with function or with function (includes methods). Methods are only a subset of associated functions.

@ibraheemdev
Copy link
Member

r=me after the nit.

@ibraheemdev ibraheemdev added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 25, 2025
@fpdotmonkey fpdotmonkey force-pushed the doc/as-fully-qualified-syntax branch 2 times, most recently from 054ee36 to 15f73ab Compare June 27, 2025 10:52
@ibraheemdev
Copy link
Member

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jun 27, 2025

📌 Commit 15f73ab has been approved by ibraheemdev

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 27, 2025
@@ -24,6 +24,20 @@
/// (`u8`, `bool`, `str`, pointers, ...) whereas `From` and `Into` also works with types like
/// `String` or `Vec`.
///
/// You'll also find with `From` and `Into`, and indeed all traits, that `as` is used for the
Copy link
Member

@fmease fmease Jun 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Revisiting this after seeing #143098)

This paragraph is placed in the middle of the as casts explainer. E.g., below it continues to talk about as _ which is confusing and disrupts the flow. Please move it to the bottom.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Furthermore, I think we should quickly mention associated items in the synopsis / introductory paragraph to give this more structure.

@@ -24,6 +24,20 @@
/// (`u8`, `bool`, `str`, pointers, ...) whereas `From` and `Into` also works with types like
/// `String` or `Vec`.
///
/// You'll also find with `From` and `Into`, and indeed all traits, that `as` is used for the
/// _fully qualified path_, a means of clarifying ambiguous associated items, i.e. functions,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// _fully qualified path_, a means of clarifying ambiguous associated items, i.e. functions,
/// _fully qualified path_, a means of disambiguating associated items, i.e. functions,

/// you'll use with `<MyThing as Into<u32>>::into(my_thing)`[^as-use-from]. This is quite verbose,
/// but fortunately, Rust's type inference usually saves you from needing this, although it is
/// occasionally necessary, especially with methods that return a generic type like `Into::into` or
/// static methods. It's more common to use in macros where it can provide necessary hygeine.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// static methods. It's more common to use in macros where it can provide necessary hygeine.
/// static methods. It's more common to use in macros where it can provide necessary hygiene.

@fmease
Copy link
Member

fmease commented Jun 27, 2025

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jun 27, 2025
@fpdotmonkey fpdotmonkey force-pushed the doc/as-fully-qualified-syntax branch from 15f73ab to c7fd35f Compare June 30, 2025 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants