docs: add documentation for find_all_refs constructor search #19861
Conversation
This file contains hidden or 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
rustbot
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
rustbot
added
has-merge-commits
S-waiting-on-author
vremyavnikuda
force-pushed
the
docs/find-all-refs-constructor-search
branch
from
abc321e to
0902094
Compare
|
rustbot
removed
has-merge-commits
S-waiting-on-author
vremyavnikuda
changed the title
vremyavnikuda
force-pushed
the
docs/find-all-refs-constructor-search
branch
from
1a68f66 to
a2b58e2
Compare
Veykril
reviewed
May 28, 2025
crates/ide/src/lib.rs
Outdated
Comment on lines
517
to
586
| /// Find all references to the item at the cursor position. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// Basic struct reference search: | ||
| /// ```rust | ||
| /// struct S { | ||
| /// pub x: usize, | ||
| /// } | ||
| /// | ||
| /// fn print_s(s: S) { | ||
| /// println!("{}", s.x) | ||
| /// } | ||
| /// | ||
| /// fn main() { | ||
| /// let s = S { x: 42 }; // This is a constructor usage | ||
| /// print_s(s); // This is a type reference | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// To find only constructor/initialization usages: | ||
| /// 1. Position cursor on special tokens in struct/enum definition: | ||
| /// ```rust | ||
| /// // On '{' - finds record struct initializations | ||
| /// struct Point { // <- cursor here on '{' | ||
| /// x: i32, | ||
| /// y: i32, | ||
| /// } | ||
| /// | ||
| /// // On '(' - finds tuple struct initializations | ||
| /// struct Tuple(i32, i32); // <- cursor here on '(' | ||
| /// | ||
| /// // On ';' - finds unit struct initializations | ||
| /// struct Unit; // <- cursor here on ';' | ||
| /// ``` | ||
| /// | ||
| /// 2. Examples of what will be found: | ||
| /// ```rust | ||
| /// struct Point{x: i32, y: i32}; | ||
| /// struct Tuple(i32, i32); | ||
| /// struct Unit; | ||
| /// | ||
| /// | ||
| /// let p1 = Point { x: 0, y: 0 }; // Found when cursor on '{' | ||
| /// let p2 = Tuple(1, 2); // Found when cursor on '(' | ||
| /// let u = Unit; // Found when cursor on ';' | ||
| /// ``` | ||
| /// | ||
| /// 3. For enum variants: | ||
| /// ```rust | ||
| /// enum E { | ||
| /// Struct { // <- cursor here on '{' | ||
| /// x: i32 | ||
| /// }, | ||
| /// Tuple(i32), // <- cursor here on '(' | ||
| /// Unit // <- cursor here on identifier | ||
| /// } | ||
| /// | ||
| /// let e1 = E::Struct { x: 0 }; // Found for Struct variant | ||
| /// let e2 = E::Tuple(1); // Found for Tuple variant | ||
| /// let e3 = E::Unit; // Found for Unit variant | ||
| /// ``` | ||
| /// | ||
| /// # Parameters | ||
| /// * `position` - The position in the file to find references for | ||
| /// * `search_scope` - Optional scope to limit the search | ||
| /// | ||
| /// # Returns | ||
| /// Returns a vector of reference search results if references are found, | ||
| /// or None if no valid item is found at the position. |
There was a problem hiding this comment.
This seems duplicated-ish. We already have the relevant docs on the implementation now, so I don't think retelling this here is beneficial (aspecially as we now have multiple places to update the docs of the features change)
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.
docs(find_all_refs): document constructor search behavior