Google Git Google Git
Sign in
rust/rust/43ab58dfd986d46d960200e703136cfb30a66e21/./src/tools/rust-analyzer/crates/ide-completion/src/render.rs
blob: 1676bc833ebdc90853f724e60f5183ffb409ba2c [file]
//! `render` module provides utilities for rendering completion suggestions
//! into code pieces that will be presented to user.
pub(crate) mod const_;
pub(crate) mod function;
pub(crate) mod literal;
pub(crate) mod macro_;
pub(crate) mod pattern;
pub(crate) mod type_alias;
pub(crate) mod union_literal;
pub(crate) mod variant;
use hir::{AsAssocItem, HasAttrs, HirDisplay, Impl, ModuleDef, ScopeDef, Type};
use ide_db::text_edit::TextEdit;
use ide_db::{
RootDatabase, SnippetCap, SymbolKind,
documentation::{Documentation, HasDocs},
helpers::item_name,
imports::import_assets::LocatedImport,
};
use syntax::{AstNode, SmolStr, SyntaxKind, TextRange, ToSmolStr, ast, format_smolstr};
use crate::{
CompletionContext, CompletionItem, CompletionItemKind, CompletionItemRefMode,
CompletionRelevance,
context::{
DotAccess, DotAccessKind, PathCompletionCtx, PathKind, PatternContext, TypeLocation,
},
item::{Builder, CompletionRelevanceTypeMatch},
render::{
function::render_fn,
literal::render_variant_lit,
macro_::{render_macro, render_macro_pat},
},
};
/// Interface for data and methods required for items rendering.
#[derive(Debug, Clone)]
pub(crate) struct RenderContext<'a, 'db> {
completion: &'a CompletionContext<'a, 'db>,
is_private_editable: bool,
import_to_add: Option<LocatedImport>,
doc_aliases: Vec<SmolStr>,
}
impl<'a, 'db> RenderContext<'a, 'db> {
pub(crate) fn new(completion: &'a CompletionContext<'a, 'db>) -> RenderContext<'a, 'db> {
RenderContext {
completion,
is_private_editable: false,
import_to_add: None,
doc_aliases: vec![],
}
}
pub(crate) fn private_editable(mut self, private_editable: bool) -> Self {
self.is_private_editable = private_editable;
self
}
pub(crate) fn import_to_add(mut self, import_to_add: Option<LocatedImport>) -> Self {
self.import_to_add = import_to_add;
self
}
pub(crate) fn doc_aliases(mut self, doc_aliases: Vec<SmolStr>) -> Self {
self.doc_aliases = doc_aliases;
self
}
fn snippet_cap(&self) -> Option<SnippetCap> {
self.completion.config.snippet_cap
}
fn db(&self) -> &'db RootDatabase {
self.completion.db
}
fn source_range(&self) -> TextRange {
self.completion.source_range()
}
fn completion_relevance(&self) -> CompletionRelevance {
CompletionRelevance {
is_private_editable: self.is_private_editable,
requires_import: self.import_to_add.is_some(),
..Default::default()
}
}
fn is_immediately_after_macro_bang(&self) -> bool {
self.completion.token.kind() == SyntaxKind::BANG
&& self.completion.token.parent().is_some_and(|it| it.kind() == SyntaxKind::MACRO_CALL)
}
/// Whether `def` is deprecated.
///
/// This can happen for two reasons:
/// - the def is marked with `#[deprecated]`
/// - the def is an assoc item whose trait is deprecated
///
/// In order to be able to check for the latter, we'd ideally want to `try_as_dyn<_, dyn AsAssocItem>(def)`
/// (see [`try_as_dyn`][]), but that function is currently unstable. Therefore, we employ a hack instead:
/// if `def` can be an assoc item, it should be passed to this method as follows:
/// ```ignore
/// self.is_deprecated(def, Some(def))
/// ```
/// otherwise, it should be passed as:
/// ```ignore
/// self.is_deprecated(def, None)
/// ```
///
/// [`try_as_dyn`]: https://doc.rust-lang.org/std/any/fn.try_as_dyn.html
fn is_deprecated(&self, def: impl HasAttrs, def_as_assoc_item: Option<hir::AssocItem>) -> bool {
let db = self.db();
def.attrs(db).is_deprecated()
|| def_as_assoc_item
.and_then(|assoc| assoc.container_or_implemented_trait(db))
.is_some_and(|trait_| {
self.is_deprecated(trait_, None /* traits can't be assoc items */)
})
}
/// Whether an enum variant should be rendered as deprecated.
///
/// A variant inherits deprecation from its parent enum, matching rustc's
/// behavior where `#[deprecated]` on an enum applies to its variants.
fn is_variant_deprecated(&self, variant: hir::EnumVariant) -> bool {
let db = self.db();
variant.attrs(db).is_deprecated() || variant.parent_enum(db).attrs(db).is_deprecated()
}
// FIXME: remove this
fn docs(&self, def: impl HasDocs) -> Option<Documentation<'a>> {
def.docs(self.db())
}
}
pub(crate) fn render_field(
ctx: RenderContext<'_, '_>,
dot_access: &DotAccess<'_>,
receiver: Option<SmolStr>,
field: hir::Field,
ty: &hir::Type<'_>,
) -> CompletionItem {
let db = ctx.db();
let is_deprecated = ctx.is_deprecated(field, None /* fields can't be assoc items */);
let name = field.name(db);
let (name, escaped_name) =
(name.as_str().to_smolstr(), name.display_no_db(ctx.completion.edition).to_smolstr());
let mut item = CompletionItem::new(
SymbolKind::Field,
ctx.source_range(),
field_with_receiver(receiver.as_deref(), &name),
ctx.completion.edition,
);
item.set_relevance(CompletionRelevance {
type_match: compute_type_match(ctx.completion, ty),
exact_name_match: compute_exact_name_match(ctx.completion, &name),
is_skipping_completion: receiver.is_some(),
..CompletionRelevance::default()
});
item.detail(ty.display(db, ctx.completion.display_target).to_string())
.set_documentation(field.docs(db))
.set_deprecated(is_deprecated)
.lookup_by(name);
let is_field_access = matches!(dot_access.kind, DotAccessKind::Field { .. });
if !is_field_access || ty.is_fn() || ty.is_closure() {
let mut builder = TextEdit::builder();
// Using TextEdit, insert '(' before the struct name and ')' before the
// dot access, then comes the field name and optionally insert function
// call parens.
builder.replace(
ctx.source_range(),
field_with_receiver(receiver.as_deref(), &escaped_name).into(),
);
let expected_fn_type =
ctx.completion.expected_type.as_ref().is_some_and(|ty| ty.is_fn() || ty.is_closure());
if !expected_fn_type
&& let Some(receiver) = &dot_access.receiver
&& let Some(receiver) = ctx.completion.sema.original_range_opt(receiver.syntax())
{
builder.insert(receiver.range.start(), "(".to_owned());
builder.insert(ctx.source_range().end(), ")".to_owned());
let is_parens_needed = !matches!(dot_access.kind, DotAccessKind::Method);
if is_parens_needed {
builder.insert(ctx.source_range().end(), "()".to_owned());
}
}
item.text_edit(builder.finish());
} else {
item.insert_text(field_with_receiver(receiver.as_deref(), &escaped_name));
}
if let Some(receiver) = &dot_access.receiver
&& let Some(original) = ctx.completion.sema.original_range_opt(receiver.syntax())
&& let Some(ref_mode) = compute_ref_match(ctx.completion, ty)
{
item.ref_match(ref_mode, original.range.start());
}
item.doc_aliases(ctx.doc_aliases);
item.build(db)
}
fn field_with_receiver(receiver: Option<&str>, field_name: &str) -> SmolStr {
receiver
.map_or_else(|| field_name.into(), |receiver| format_smolstr!("{}.{field_name}", receiver))
}
pub(crate) fn render_tuple_field(
ctx: RenderContext<'_, '_>,
receiver: Option<SmolStr>,
field: usize,
ty: &hir::Type<'_>,
) -> CompletionItem {
let mut item = CompletionItem::new(
SymbolKind::Field,
ctx.source_range(),
field_with_receiver(receiver.as_deref(), &field.to_string()),
ctx.completion.edition,
);
item.detail(ty.display(ctx.db(), ctx.completion.display_target).to_string())
.lookup_by(field.to_string());
item.set_relevance(CompletionRelevance {
is_skipping_completion: receiver.is_some(),
..ctx.completion_relevance()
});
item.build(ctx.db())
}
pub(crate) fn render_type_inference(
ty_string: String,
ctx: &CompletionContext<'_, '_>,
path_ctx: &PathCompletionCtx<'_>,
) -> CompletionItem {
let mut builder = CompletionItem::new(
CompletionItemKind::InferredType,
ctx.source_range(),
&ty_string,
ctx.edition,
);
adds_ret_type_arrow(ctx, path_ctx, &mut builder, ty_string);
builder.set_relevance(CompletionRelevance {
type_match: Some(CompletionRelevanceTypeMatch::Exact),
exact_name_match: true,
..Default::default()
});
builder.build(ctx.db)
}
pub(crate) fn render_path_resolution<'db>(
ctx: RenderContext<'_, 'db>,
path_ctx: &PathCompletionCtx<'_>,
local_name: hir::Name,
resolution: ScopeDef<'db>,
) -> Builder {
render_resolution_path(ctx, path_ctx, local_name, None, resolution)
}
pub(crate) fn render_pattern_resolution<'db>(
ctx: RenderContext<'_, 'db>,
pattern_ctx: &PatternContext,
local_name: hir::Name,
resolution: ScopeDef<'db>,
) -> Builder {
render_resolution_pat(ctx, pattern_ctx, local_name, None, resolution)
}
pub(crate) fn render_resolution_with_import(
ctx: RenderContext<'_, '_>,
path_ctx: &PathCompletionCtx<'_>,
import_edit: LocatedImport,
) -> Option<Builder> {
let resolution = ScopeDef::from(import_edit.original_item);
let local_name = get_import_name(resolution, &ctx, &import_edit)?;
// This now just renders the alias text, but we need to find the aliases earlier and call this with the alias instead.
let doc_aliases = ctx.completion.doc_aliases_in_scope(resolution);
let ctx = ctx.doc_aliases(doc_aliases);
Some(render_resolution_path(ctx, path_ctx, local_name, Some(import_edit), resolution))
}
pub(crate) fn render_resolution_with_import_pat(
ctx: RenderContext<'_, '_>,
pattern_ctx: &PatternContext,
import_edit: LocatedImport,
) -> Option<Builder> {
let resolution = ScopeDef::from(import_edit.original_item);
let local_name = get_import_name(resolution, &ctx, &import_edit)?;
Some(render_resolution_pat(ctx, pattern_ctx, local_name, Some(import_edit), resolution))
}
pub(crate) fn render_expr<'db>(
ctx: &CompletionContext<'_, 'db>,
expr: &hir::term_search::Expr<'db>,
) -> Option<Builder> {
let mut i = 1;
let mut snippet_formatter = |ty: &hir::Type<'_>| {
let arg_name = ty
.as_adt()
.map(|adt| stdx::to_lower_snake_case(adt.name(ctx.db).as_str()))
.unwrap_or_else(|| String::from("_"));
let res = format!("${{{i}:{arg_name}}}");
i += 1;
res
};
let mut label_formatter = |ty: &hir::Type<'_>| {
ty.as_adt()
.map(|adt| stdx::to_lower_snake_case(adt.name(ctx.db).as_str()))
.unwrap_or_else(|| String::from("..."))
};
let cfg = ctx.config.find_path_config(ctx.is_nightly);
let label =
expr.gen_source_code(&ctx.scope, &mut label_formatter, cfg, ctx.display_target).ok()?;
let source_range = match ctx.original_token.parent() {
Some(node) => match node.ancestors().find_map(ast::Path::cast) {
Some(path) => path.syntax().text_range(),
None => node.text_range(),
},
None => ctx.source_range(),
};
let mut item =
CompletionItem::new(CompletionItemKind::Expression, source_range, label, ctx.edition);
let snippet = format!(
"{}$0",
expr.gen_source_code(&ctx.scope, &mut snippet_formatter, cfg, ctx.display_target).ok()?
);
let edit = TextEdit::replace(source_range, snippet);
item.snippet_edit(ctx.config.snippet_cap?, edit);
item.documentation(Documentation::new_owned(String::from(
"Autogenerated expression by term search",
)));
item.set_relevance(crate::CompletionRelevance {
type_match: compute_type_match(ctx, &ctx.rebase_ty(&expr.ty(ctx.db))),
..Default::default()
});
for trait_ in expr.traits_used(ctx.db) {
let trait_item = hir::ItemInNs::from(hir::ModuleDef::from(trait_));
let Some(path) = ctx.module.find_path(ctx.db, trait_item, cfg) else {
continue;
};
item.add_import(LocatedImport::new_no_completion(path, trait_item, trait_item));
}
Some(item)
}
fn get_import_name<'db>(
resolution: ScopeDef<'db>,
ctx: &RenderContext<'_, 'db>,
import_edit: &LocatedImport,
) -> Option<hir::Name> {
// FIXME: Temporary workaround for handling aliased import.
// This should be removed after we have proper support for importing alias.
// <https://github.com/rust-lang/rust-analyzer/issues/14079>
// If `item_to_import` matches `original_item`, we are importing the item itself (not its parent module).
// In this case, we can use the last segment of `import_path`, as it accounts for the aliased name.
if import_edit.item_to_import == import_edit.original_item {
import_edit.import_path.segments().last().cloned()
} else {
scope_def_to_name(resolution, ctx, import_edit)
}
}
fn scope_def_to_name<'db>(
resolution: ScopeDef<'db>,
ctx: &RenderContext<'_, 'db>,
import_edit: &LocatedImport,
) -> Option<hir::Name> {
Some(match resolution {
ScopeDef::ModuleDef(hir::ModuleDef::Function(f)) => f.name(ctx.completion.db),
ScopeDef::ModuleDef(hir::ModuleDef::Const(c)) => c.name(ctx.completion.db)?,
ScopeDef::ModuleDef(hir::ModuleDef::TypeAlias(t)) => t.name(ctx.completion.db),
_ => item_name(ctx.db(), import_edit.original_item)?,
})
}
fn render_resolution_pat<'db>(
ctx: RenderContext<'_, 'db>,
pattern_ctx: &PatternContext,
local_name: hir::Name,
import_to_add: Option<LocatedImport>,
resolution: ScopeDef<'db>,
) -> Builder {
let _p = tracing::info_span!("render_resolution_pat").entered();
use hir::ModuleDef::*;
if let ScopeDef::ModuleDef(Macro(mac)) = resolution {
let ctx = ctx.import_to_add(import_to_add);
render_macro_pat(ctx, pattern_ctx, local_name, mac)
} else {
render_resolution_simple_(ctx, &local_name, import_to_add, resolution)
}
}
fn render_resolution_path<'db>(
ctx: RenderContext<'_, 'db>,
path_ctx: &PathCompletionCtx<'_>,
local_name: hir::Name,
import_to_add: Option<LocatedImport>,
resolution: ScopeDef<'db>,
) -> Builder {
let _p = tracing::info_span!("render_resolution_path").entered();
use hir::ModuleDef::*;
let krate = ctx.completion.display_target;
match resolution {
ScopeDef::ModuleDef(Macro(mac)) => {
let ctx = ctx.import_to_add(import_to_add);
return render_macro(ctx, path_ctx, local_name, mac);
}
ScopeDef::ModuleDef(Function(func)) => {
let ctx = ctx.import_to_add(import_to_add);
return render_fn(ctx, path_ctx, Some(local_name), func);
}
ScopeDef::ModuleDef(EnumVariant(var)) => {
let ctx = ctx.clone().import_to_add(import_to_add.clone());
if let Some(item) =
render_variant_lit(ctx, path_ctx, Some(local_name.clone()), var, None)
{
return item;
}
}
_ => (),
}
let completion = ctx.completion;
let module = completion.module;
let cap = ctx.snippet_cap();
let db = completion.db;
let config = completion.config;
let requires_import = import_to_add.is_some();
let name = local_name.display(db, completion.edition).to_smolstr();
let mut item = render_resolution_simple_(ctx, &local_name, import_to_add, resolution);
let mut insert_text = name.clone();
// Add `<>` for generic types
let type_path_no_ty_args = matches!(
path_ctx,
PathCompletionCtx { kind: PathKind::Type { .. }, has_type_args: false, .. }
) && config.callable.is_some();
if type_path_no_ty_args && let Some(cap) = cap {
let has_non_default_type_params = match resolution {
ScopeDef::ModuleDef(hir::ModuleDef::Adt(it)) => it.has_non_default_type_params(db),
ScopeDef::ModuleDef(hir::ModuleDef::TypeAlias(it)) => {
it.has_non_default_type_params(db)
}
_ => false,
};
if has_non_default_type_params {
cov_mark::hit!(inserts_angle_brackets_for_generics);
insert_text = format_smolstr!("{insert_text}<$0>");
item.lookup_by(name.clone())
.label(SmolStr::from_iter([&name, "<…>"]))
.trigger_call_info()
.insert_snippet(cap, ""); // set is snippet
}
}
let allow_module_path = matches!(path_ctx.kind, PathKind::Use)
|| completion.token.next_token().is_some_and(|it| it.kind() == syntax::T![::])
|| !config.add_colons_to_module;
if !allow_module_path && matches!(resolution, ScopeDef::ModuleDef(Module(_))) {
insert_text = format_smolstr!("{insert_text}::");
item.lookup_by(name.clone()).label(insert_text.clone());
}
adds_ret_type_arrow(completion, path_ctx, &mut item, insert_text.into());
let mut set_item_relevance = |ty: Type<'db>| {
if !ty.is_unknown() {
item.detail(ty.display(db, krate).to_string());
}
let ty = completion.rebase_ty(&ty);
item.set_relevance(CompletionRelevance {
type_match: compute_type_match(completion, &ty),
exact_name_match: compute_exact_name_match(completion, &name),
is_local: matches!(resolution, ScopeDef::Local(_)),
requires_import,
has_local_inherent_impl: compute_has_local_inherent_impl(db, path_ctx, &ty, module),
..CompletionRelevance::default()
});
match resolution {
ScopeDef::Local(_)
| ScopeDef::ModuleDef(ModuleDef::Const(_) | ModuleDef::Static(_)) => {
path_ref_match(completion, path_ctx, &ty, &mut item)
}
_ => (),
}
};
match resolution {
ScopeDef::Local(local) => set_item_relevance(local.ty(db)),
ScopeDef::ModuleDef(ModuleDef::Adt(adt)) | ScopeDef::AdtSelfType(adt) => {
set_item_relevance(adt.ty(db))
}
// Filtered out above
ScopeDef::ModuleDef(
ModuleDef::Function(_) | ModuleDef::EnumVariant(_) | ModuleDef::Macro(_),
) => (),
ScopeDef::ModuleDef(ModuleDef::Const(konst)) => set_item_relevance(konst.ty(db)),
ScopeDef::ModuleDef(ModuleDef::Static(stat)) => set_item_relevance(stat.ty(db)),
ScopeDef::ModuleDef(ModuleDef::BuiltinType(bt)) => set_item_relevance(bt.ty(db)),
ScopeDef::ModuleDef(ModuleDef::TypeAlias(ta)) => set_item_relevance(ta.ty(db)),
ScopeDef::ImplSelfType(imp) => set_item_relevance(imp.self_ty(db)),
ScopeDef::GenericParam(_)
| ScopeDef::Label(_)
| ScopeDef::Unknown
| ScopeDef::ModuleDef(ModuleDef::Trait(_) | ModuleDef::Module(_)) => (),
};
item
}
fn render_resolution_simple_<'db>(
ctx: RenderContext<'_, 'db>,
local_name: &hir::Name,
import_to_add: Option<LocatedImport>,
resolution: ScopeDef<'db>,
) -> Builder {
let _p = tracing::info_span!("render_resolution_simple_").entered();
let db = ctx.db();
let ctx = ctx.import_to_add(import_to_add);
let kind = res_to_kind(resolution);
let mut item = CompletionItem::new(
kind,
ctx.source_range(),
local_name.as_str().to_smolstr(),
ctx.completion.edition,
);
if let ScopeDef::ModuleDef(ModuleDef::Const(konst)) = resolution {
item.const_value(Some(konst), db, ctx.completion.display_target);
}
item.set_relevance(ctx.completion_relevance())
.set_documentation(scope_def_docs(db, resolution))
.set_deprecated(scope_def_is_deprecated(&ctx, resolution));
if let Some(import_to_add) = ctx.import_to_add {
item.add_import(import_to_add);
}
item.doc_aliases(ctx.doc_aliases);
item
}
fn res_to_kind(resolution: ScopeDef<'_>) -> CompletionItemKind {
use hir::ModuleDef::*;
match resolution {
ScopeDef::Unknown => CompletionItemKind::UnresolvedReference,
ScopeDef::ModuleDef(Function(_)) => CompletionItemKind::SymbolKind(SymbolKind::Function),
ScopeDef::ModuleDef(EnumVariant(_)) => CompletionItemKind::SymbolKind(SymbolKind::Variant),
ScopeDef::ModuleDef(Macro(_)) => CompletionItemKind::SymbolKind(SymbolKind::Macro),
ScopeDef::ModuleDef(Module(..)) => CompletionItemKind::SymbolKind(SymbolKind::Module),
ScopeDef::ModuleDef(Adt(adt)) => CompletionItemKind::SymbolKind(match adt {
hir::Adt::Struct(_) => SymbolKind::Struct,
hir::Adt::Union(_) => SymbolKind::Union,
hir::Adt::Enum(_) => SymbolKind::Enum,
}),
ScopeDef::ModuleDef(Const(..)) => CompletionItemKind::SymbolKind(SymbolKind::Const),
ScopeDef::ModuleDef(Static(..)) => CompletionItemKind::SymbolKind(SymbolKind::Static),
ScopeDef::ModuleDef(Trait(..)) => CompletionItemKind::SymbolKind(SymbolKind::Trait),
ScopeDef::ModuleDef(TypeAlias(..)) => CompletionItemKind::SymbolKind(SymbolKind::TypeAlias),
ScopeDef::ModuleDef(BuiltinType(..)) => CompletionItemKind::BuiltinType,
ScopeDef::GenericParam(param) => CompletionItemKind::SymbolKind(match param {
hir::GenericParam::TypeParam(_) => SymbolKind::TypeParam,
hir::GenericParam::ConstParam(_) => SymbolKind::ConstParam,
hir::GenericParam::LifetimeParam(_) => SymbolKind::LifetimeParam,
}),
ScopeDef::Local(..) => CompletionItemKind::SymbolKind(SymbolKind::Local),
ScopeDef::Label(..) => CompletionItemKind::SymbolKind(SymbolKind::Label),
ScopeDef::AdtSelfType(..) | ScopeDef::ImplSelfType(..) => {
CompletionItemKind::SymbolKind(SymbolKind::SelfParam)
}
}
}
fn scope_def_docs<'db>(
db: &'db RootDatabase,
resolution: ScopeDef<'db>,
) -> Option<Documentation<'db>> {
use hir::ModuleDef::*;
match resolution {
ScopeDef::ModuleDef(Module(it)) => it.docs(db),
ScopeDef::ModuleDef(Adt(it)) => it.docs(db),
ScopeDef::ModuleDef(EnumVariant(it)) => it.docs(db),
ScopeDef::ModuleDef(Const(it)) => it.docs(db),
ScopeDef::ModuleDef(Static(it)) => it.docs(db),
ScopeDef::ModuleDef(Trait(it)) => it.docs(db),
ScopeDef::ModuleDef(TypeAlias(it)) => it.docs(db),
_ => None,
}
}
fn scope_def_is_deprecated(ctx: &RenderContext<'_, '_>, resolution: ScopeDef<'_>) -> bool {
let db = ctx.db();
match resolution {
ScopeDef::ModuleDef(hir::ModuleDef::EnumVariant(it)) => ctx.is_variant_deprecated(it),
ScopeDef::ModuleDef(it) => ctx.is_deprecated(it, it.as_assoc_item(db)),
ScopeDef::GenericParam(it) => {
ctx.is_deprecated(it, None /* generic params can't be assoc items */)
}
ScopeDef::AdtSelfType(it) => {
ctx.is_deprecated(it, None /* `Self` can't be an assoc item */)
}
_ => false,
}
}
pub(crate) fn render_type_keyword_snippet(
ctx: &CompletionContext<'_, '_>,
path_ctx: &PathCompletionCtx<'_>,
label: &str,
snippet: &str,
) -> Builder {
let source_range = ctx.source_range();
let mut item =
CompletionItem::new(CompletionItemKind::Keyword, source_range, label, ctx.edition);
let insert_text = if !snippet.contains('$') {
item.insert_text(snippet);
snippet
} else if let Some(cap) = ctx.config.snippet_cap {
item.insert_snippet(cap, snippet);
snippet
} else {
label
};
adds_ret_type_arrow(ctx, path_ctx, &mut item, insert_text.to_owned());
item
}
fn adds_ret_type_arrow(
ctx: &CompletionContext<'_, '_>,
path_ctx: &PathCompletionCtx<'_>,
item: &mut Builder,
insert_text: String,
) {
if let Some((arrow, at)) = path_ctx.required_thin_arrow(&ctx.sema) {
let mut edit = TextEdit::builder();
edit.insert(at, arrow.to_owned());
edit.replace(ctx.source_range(), insert_text);
item.text_edit(edit.finish()).adds_text(SmolStr::new_static(arrow));
} else {
item.insert_text(insert_text);
}
}
// FIXME: This checks types without possible coercions which some completions might want to do
fn match_types(
ctx: &CompletionContext<'_, '_>,
ty1: &hir::Type<'_>,
ty2: &hir::Type<'_>,
) -> Option<CompletionRelevanceTypeMatch> {
if ty1 == ty2 {
Some(CompletionRelevanceTypeMatch::Exact)
} else if ty1.could_unify_with(ctx.db, ty2) {
Some(CompletionRelevanceTypeMatch::CouldUnify)
} else {
None
}
}
fn compute_type_match(
ctx: &CompletionContext<'_, '_>,
completion_ty: &hir::Type<'_>,
) -> Option<CompletionRelevanceTypeMatch> {
let expected_type = ctx.expected_type.as_ref()?;
// We don't ever consider unit type to be an exact type match, since
// nearly always this is not meaningful to the user.
if expected_type.is_unit() || completion_ty.is_unit() {
return None;
}
if expected_type.is_unknown() || completion_ty.is_unknown() {
return None;
}
// &mut ty -> &ty
if completion_ty.is_mutable_reference()
&& let Some((expected_type, _)) = expected_type.as_reference()
&& let Some((completion_ty, _)) = completion_ty.as_reference()
{
return match_types(ctx, &expected_type, &completion_ty);
}
match_types(ctx, expected_type, completion_ty)
}
fn compute_has_local_inherent_impl(
db: &RootDatabase,
path_ctx: &PathCompletionCtx<'_>,
completion_ty: &hir::Type<'_>,
curr_module: hir::Module,
) -> bool {
matches!(path_ctx.kind, PathKind::Type { location: TypeLocation::ImplTarget })
&& Impl::all_for_type(db, completion_ty.clone())
.iter()
.any(|imp| imp.trait_(db).is_none() && imp.module(db) == curr_module)
}
fn compute_exact_name_match(ctx: &CompletionContext<'_, '_>, completion_name: &str) -> bool {
ctx.expected_name.as_ref().is_some_and(|name| {
let name = name.text().strip_prefix("r#").unwrap_or(name.text());
let completion_name = completion_name.strip_prefix("r#").unwrap_or(completion_name);
name.trim_matches('_') == completion_name.trim_matches('_')
})
}
fn compute_ref_match(
ctx: &CompletionContext<'_, '_>,
completion_ty: &hir::Type<'_>,
) -> Option<CompletionItemRefMode> {
if compute_type_match(ctx, completion_ty).is_some() || completion_ty.is_unit() {
return None;
}
let expected_type = ctx.expected_type.as_ref()?;
let expected_without_ref = expected_type.as_reference();
let completion_without_ref = completion_ty.as_reference();
if let Some((expected_without_ref, _)) = &expected_without_ref
&& (completion_without_ref.is_none()
|| completion_ty.could_unify_with(ctx.db, expected_without_ref))
&& completion_ty
.autoderef(ctx.db)
.any(|ty| !ty.is_unknown() && ty.could_unify_with(ctx.db, expected_without_ref))
{
cov_mark::hit!(suggest_ref);
let mutability = if expected_type.is_mutable_reference() {
hir::Mutability::Mut
} else {
hir::Mutability::Shared
};
return Some(CompletionItemRefMode::Reference(mutability));
}
if let Some((completion_without_ref, _)) = completion_without_ref
&& completion_without_ref == *expected_type
&& completion_without_ref.is_copy(ctx.db)
{
cov_mark::hit!(suggest_deref);
return Some(CompletionItemRefMode::Dereference);
}
None
}
fn path_ref_match(
completion: &CompletionContext<'_, '_>,
path_ctx: &PathCompletionCtx<'_>,
ty: &hir::Type<'_>,
item: &mut Builder,
) {
if let Some(original_path) = &path_ctx.original_path {
// At least one char was typed by the user already, in that case look for the original path
if let Some(original_path) = completion.sema.original_range_opt(original_path.syntax())
&& let Some(ref_mode) = compute_ref_match(completion, ty)
{
item.ref_match(ref_mode, original_path.range.start());
}
} else {
// completion requested on an empty identifier, there is no path here yet.
// FIXME: This might create inconsistent completions where we show a ref match in macro inputs
// as long as nothing was typed yet
if let Some(ref_mode) = compute_ref_match(completion, ty) {
item.ref_match(ref_mode, completion.source_range().start());
}
}
}
#[cfg(test)]
mod tests {
use std::cmp;
use expect_test::{Expect, expect};
use ide_db::SymbolKind;
use itertools::Itertools;
use crate::{
CompletionItem, CompletionItemKind, CompletionRelevance, CompletionRelevancePostfixMatch,
item::CompletionRelevanceTypeMatch,
tests::{TEST_CONFIG, check_edit, do_completion, get_all_items},
};
#[track_caller]
fn check(
#[rust_analyzer::rust_fixture] ra_fixture: &str,
kind: impl Into<CompletionItemKind>,
expect: Expect,
) {
let actual = do_completion(ra_fixture, kind.into());
expect.assert_debug_eq(&actual);
}
#[track_caller]
fn check_kinds(
#[rust_analyzer::rust_fixture] ra_fixture: &str,
kinds: &[CompletionItemKind],
expect: Expect,
) {
let actual: Vec<_> =
kinds.iter().flat_map(|&kind| do_completion(ra_fixture, kind)).collect();
expect.assert_debug_eq(&actual);
}
#[track_caller]
fn check_function_relevance(#[rust_analyzer::rust_fixture] ra_fixture: &str, expect: Expect) {
let actual: Vec<_> =
do_completion(ra_fixture, CompletionItemKind::SymbolKind(SymbolKind::Method))
.into_iter()
.map(|item| (item.detail.unwrap_or_default(), item.relevance.function))
.collect();
expect.assert_debug_eq(&actual);
}
#[track_caller]
fn check_relevance_for_kinds(
#[rust_analyzer::rust_fixture] ra_fixture: &str,
kinds: &[CompletionItemKind],
expect: Expect,
) {
let mut actual = get_all_items(TEST_CONFIG, ra_fixture, None);
actual.retain(|it| kinds.contains(&it.kind));
actual.sort_by_key(|it| (cmp::Reverse(it.relevance.score()), it.label.primary.clone()));
check_relevance_(actual, expect);
}
#[track_caller]
fn check_relevance(#[rust_analyzer::rust_fixture] ra_fixture: &str, expect: Expect) {
let mut actual = get_all_items(TEST_CONFIG, ra_fixture, None);
actual.retain(|it| it.kind != CompletionItemKind::Snippet);
actual.retain(|it| it.kind != CompletionItemKind::Keyword);
actual.retain(|it| it.kind != CompletionItemKind::BuiltinType);
actual.sort_by_key(|it| (cmp::Reverse(it.relevance.score()), it.label.primary.clone()));
check_relevance_(actual, expect);
}
#[track_caller]
fn check_relevance_(actual: Vec<CompletionItem>, expect: Expect) {
let actual = actual
.into_iter()
.flat_map(|it| {
let mut items = vec![];
let tag = it.kind.tag();
let relevance = display_relevance(it.relevance);
items.push(format!(
"{tag} {} {} {relevance}\n",
it.label.primary,
it.label.detail_right.as_deref().unwrap_or_default(),
));
if let Some((label, _indel, relevance)) = it.ref_match() {
let relevance = display_relevance(relevance);
items.push(format!("{tag} {label} {relevance}\n"));
}
items
})
.collect::<String>();
expect.assert_eq(&actual);
fn display_relevance(relevance: CompletionRelevance) -> String {
let CompletionRelevance {
exact_name_match,
type_match,
is_local,
is_missing,
trait_,
is_name_already_imported: _,
requires_import,
is_private_editable: _,
postfix_match,
function: _,
is_skipping_completion: _,
has_local_inherent_impl,
is_deprecated,
} = relevance;
let relevance_factors = [
(type_match == Some(CompletionRelevanceTypeMatch::Exact), "type"),
(type_match == Some(CompletionRelevanceTypeMatch::CouldUnify), "type_could_unify"),
(exact_name_match, "name"),
(is_local, "local"),
(is_missing, "missing"),
(postfix_match == Some(CompletionRelevancePostfixMatch::Exact), "snippet"),
(trait_.is_some_and(|it| it.is_op_method), "op_method"),
(requires_import, "requires_import"),
(has_local_inherent_impl, "has_local_inherent_impl"),
(is_deprecated, "deprecated"),
]
.into_iter()
.filter_map(|(cond, desc)| cond.then_some(desc))
.join("+");
format!("[{relevance_factors}]")
}
}
#[test]
fn trait_imported_as_underscore_should_not_appear_auto_import_again() {
// make sure there has no `requires_import`
// see https://github.com/rust-lang/rust-analyzer/issues/19767
check_relevance(
r#"
//- /dep.rs crate:dep
pub trait MyTrait {
fn my_method(&self);
}
//- /main.rs crate:main deps:dep
use dep::MyTrait as _;
struct MyStruct;
impl dep::MyTrait for MyStruct {
fn my_method(&self) {}
}
fn main() {
MyStruct::my_method$0
}
"#,
expect![[r#"
me my_method(…) fn(&self) []
"#]],
);
}
#[test]
fn set_struct_type_completion_info() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub mod test_mod_b {
pub struct Struct {}
}
pub mod test_mod_a {
pub struct Struct {}
}
//- /main.rs crate:main deps:dep
fn test(input: dep::test_mod_b::Struct) { }
fn main() {
test(Struct$0);
}
"#,
expect![[r#"
st dep::test_mod_b::Struct {…} dep::test_mod_b::Struct { } [type]
ex dep::test_mod_b::Struct { } [type]
st Struct Struct [type+requires_import]
md dep:: []
fn main() fn() []
fn test(…) fn(Struct) []
st Struct Struct [requires_import]
"#]],
);
}
#[test]
fn set_union_type_completion_info() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub mod test_mod_b {
pub union Union {
a: i32,
b: i32
}
}
pub mod test_mod_a {
pub enum Union {
a: i32,
b: i32
}
}
//- /main.rs crate:main deps:dep
fn test(input: dep::test_mod_b::Union) { }
fn main() {
test(Union$0);
}
"#,
expect![[r#"
un Union Union [type+requires_import]
md dep:: []
fn main() fn() []
fn test(…) fn(Union) []
en Union Union [requires_import]
"#]],
);
}
#[test]
fn set_enum_type_completion_info() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub mod test_mod_b {
pub enum Enum {
variant
}
}
pub mod test_mod_a {
pub enum Enum {
variant
}
}
//- /main.rs crate:main deps:dep
fn test(input: dep::test_mod_b::Enum) { }
fn main() {
test(Enum$0);
}
"#,
expect![[r#"
ev dep::test_mod_b::Enum::variant dep::test_mod_b::Enum::variant [type]
ex dep::test_mod_b::Enum::variant [type]
en Enum Enum [type+requires_import]
md dep:: []
fn main() fn() []
fn test(…) fn(Enum) []
en Enum Enum [requires_import]
"#]],
);
}
#[test]
fn set_enum_variant_type_completion_info() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub mod test_mod_b {
pub enum Enum {
Variant
}
}
pub mod test_mod_a {
pub enum Enum {
Variant
}
}
//- /main.rs crate:main deps:dep
fn test(input: dep::test_mod_b::Enum) { }
fn main() {
test(Variant$0);
}
"#,
expect![[r#"
ev dep::test_mod_b::Enum::Variant dep::test_mod_b::Enum::Variant [type]
ex dep::test_mod_b::Enum::Variant [type]
ev Variant Variant [type+requires_import]
md dep:: []
fn main() fn() []
fn test(…) fn(Enum) []
ev Variant Variant [requires_import]
"#]],
);
}
#[test]
fn set_fn_type_completion_info() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub mod test_mod_b {
pub fn function(j: isize) -> i32 {}
}
pub mod test_mod_a {
pub fn function(i: usize) -> i32 {}
}
//- /main.rs crate:main deps:dep
fn test(input: fn(usize) -> i32) { }
fn main() {
test(function$0);
}
"#,
expect![[r#"
md dep:: []
fn main() fn() []
fn test(…) fn(fn(usize) -> i32) []
fn function fn(usize) -> i32 [requires_import]
fn function(…) fn(isize) -> i32 [requires_import]
"#]],
);
}
#[test]
fn set_const_type_completion_info() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub mod test_mod_b {
pub const CONST: i32 = 1;
}
pub mod test_mod_a {
pub const CONST: i64 = 2;
}
//- /main.rs crate:main deps:dep
fn test(input: i32) { }
fn main() {
test(CONST$0);
}
"#,
expect![[r#"
ct CONST i32 [type+requires_import]
md dep:: []
fn main() fn() []
fn test(…) fn(i32) []
ct CONST i64 [requires_import]
"#]],
);
}
#[test]
fn set_static_type_completion_info() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub mod test_mod_b {
pub static STATIC: i32 = 5;
}
pub mod test_mod_a {
pub static STATIC: i64 = 5;
}
//- /main.rs crate:main deps:dep
fn test(input: i32) { }
fn main() {
test(STATIC$0);
}
"#,
expect![[r#"
sc STATIC i32 [type+requires_import]
md dep:: []
fn main() fn() []
fn test(…) fn(i32) []
sc STATIC i64 [requires_import]
"#]],
);
}
#[test]
fn set_self_type_completion_info_with_params() {
check_relevance(
r#"
//- /lib.rs crate:dep
pub struct Struct;
impl Struct {
pub fn Function(&self, input: i32) -> bool {
false
}
}
//- /main.rs crate:main deps:dep
use dep::Struct;
fn test(input: fn(&dep::Struct, i32) -> bool) { }
fn main() {
test(Struct::Function$0);
}
"#,
expect![[r#"
me Function fn(&self, i32) -> bool []
"#]],
);
}
#[test]
fn set_self_type_completion_info() {
check_relevance(
r#"
//- /main.rs crate:main
struct Struct;
impl Struct {
fn test(&self) {
func(Self$0);
}
}
fn func(input: Struct) { }
"#,
expect![[r#"
st Self Self [type]
st Struct Struct [type]
sp Self Struct [type]
st Struct Struct [type]
ex Struct [type]
lc self &Struct [local]
fn func(…) fn(Struct) []
me self.test() fn(&self) []
"#]],
);
}
#[test]
fn set_type_alias_completion_info() {
check_relevance(
r#"
//- /main.rs crate:main
struct Struct;
type Alias = Struct;
impl Struct {
fn test(&self) {
func(Self$0);
}
}
fn func(input: Struct) { }
"#,
expect![[r#"
st Self Self [type]
st Struct Struct [type]
ta Alias Struct [type]
sp Self Struct [type]
st Struct Struct [type]
ex Struct [type]
lc self &Struct [local]
fn func(…) fn(Struct) []
me self.test() fn(&self) []
"#]],
);
}
#[test]
fn set_builtin_type_completion_info() {
check_relevance(
r#"
//- /main.rs crate:main
fn test(input: bool) { }
pub Input: bool = false;
fn main() {
let input = false;
let inputbad = 3;
test(inp$0);
}
"#,
expect![[r#"
lc input bool [type+name+local]
ex false [type]
ex input [type]
ex true [type]
lc inputbad i32 [local]
fn main() fn() []
fn test(…) fn(bool) []
"#]],
);
}
#[test]
fn enum_detail_includes_record_fields() {
check(
r#"
enum Foo { Foo { x: i32, y: i32 } }
fn main() { Foo::Fo$0 }
"#,
SymbolKind::Variant,
expect![[r#"
[
CompletionItem {
label: "Foo {…}",
detail_left: None,
detail_right: Some(
"Foo { x: i32, y: i32 }",
),
source_range: 54..56,
delete: 54..56,
insert: "Foo { x: ${1:()}, y: ${2:()} }$0",
kind: SymbolKind(
Variant,
),
lookup: "Foo{}",
detail: "Foo { x: i32, y: i32 }",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
trigger_call_info: true,
},
]
"#]],
);
}
#[test]
fn enum_detail_includes_tuple_fields() {
check(
r#"
enum Foo { Foo (i32, i32) }
fn main() { Foo::Fo$0 }
"#,
SymbolKind::Variant,
expect![[r#"
[
CompletionItem {
label: "Foo(…)",
detail_left: None,
detail_right: Some(
"Foo(i32, i32)",
),
source_range: 46..48,
delete: 46..48,
insert: "Foo(${1:()}, ${2:()})$0",
kind: SymbolKind(
Variant,
),
lookup: "Foo()",
detail: "Foo(i32, i32)",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
trigger_call_info: true,
},
]
"#]],
);
}
#[test]
fn fn_detail_includes_args_and_return_type() {
check(
r#"
fn foo<T>(a: u32, b: u32, t: T) -> (u32, T) { (a, t) }
fn main() { fo$0 }
"#,
SymbolKind::Function,
expect![[r#"
[
CompletionItem {
label: "foo(…)",
detail_left: None,
detail_right: Some(
"fn(u32, u32, T) -> (u32, T)",
),
source_range: 68..70,
delete: 68..70,
insert: "foo(${1:a}, ${2:b}, ${3:t})$0",
kind: SymbolKind(
Function,
),
lookup: "foo",
detail: "fn(u32, u32, T) -> (u32, T)",
trigger_call_info: true,
},
CompletionItem {
label: "main()",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 68..70,
delete: 68..70,
insert: "main();$0",
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
]
"#]],
);
}
#[test]
fn fn_detail_includes_variadics() {
check(
r#"
unsafe extern "C" fn foo(a: u32, b: u32, ...) {}
fn main() { fo$0 }
"#,
SymbolKind::Function,
expect![[r#"
[
CompletionItem {
label: "foo(…)",
detail_left: None,
detail_right: Some(
"unsafe fn(u32, u32, ...)",
),
source_range: 62..64,
delete: 62..64,
insert: "foo(${1:a}, ${2:b});$0",
kind: SymbolKind(
Function,
),
lookup: "foo",
detail: "unsafe fn(u32, u32, ...)",
trigger_call_info: true,
},
CompletionItem {
label: "main()",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 62..64,
delete: 62..64,
insert: "main();$0",
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
]
"#]],
);
}
#[test]
fn enum_detail_just_name_for_unit() {
check(
r#"
enum Foo { Foo }
fn main() { Foo::Fo$0 }
"#,
SymbolKind::Variant,
expect![[r#"
[
CompletionItem {
label: "Foo",
detail_left: None,
detail_right: Some(
"Foo",
),
source_range: 35..37,
delete: 35..37,
insert: "Foo$0",
kind: SymbolKind(
Variant,
),
detail: "Foo",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: false,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
trigger_call_info: true,
},
]
"#]],
);
}
#[test]
fn lookup_enums_by_two_qualifiers() {
check_kinds(
r#"
mod m {
pub enum Spam { Foo, Bar(i32) }
}
fn main() { let _: m::Spam = S$0 }
"#,
&[
CompletionItemKind::SymbolKind(SymbolKind::Function),
CompletionItemKind::SymbolKind(SymbolKind::Module),
CompletionItemKind::SymbolKind(SymbolKind::Variant),
],
expect![[r#"
[
CompletionItem {
label: "main()",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 75..76,
delete: 75..76,
insert: "main();$0",
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
CompletionItem {
label: "m::",
detail_left: None,
detail_right: None,
source_range: 75..76,
delete: 75..76,
insert: "m::",
kind: SymbolKind(
Module,
),
lookup: "m",
},
CompletionItem {
label: "m::Spam::Bar(…)",
detail_left: None,
detail_right: Some(
"m::Spam::Bar(i32)",
),
source_range: 75..76,
delete: 75..76,
insert: "m::Spam::Bar(${1:()})$0",
kind: SymbolKind(
Variant,
),
lookup: "Spam::Bar()",
detail: "m::Spam::Bar(i32)",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: Some(
Exact,
),
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
trigger_call_info: true,
},
CompletionItem {
label: "m::Spam::Foo",
detail_left: None,
detail_right: Some(
"m::Spam::Foo",
),
source_range: 75..76,
delete: 75..76,
insert: "m::Spam::Foo$0",
kind: SymbolKind(
Variant,
),
lookup: "Spam::Foo",
detail: "m::Spam::Foo",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: Some(
Exact,
),
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: false,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
trigger_call_info: true,
},
]
"#]],
)
}
#[test]
fn sets_deprecated_flag_in_items() {
check(
r#"
#[deprecated]
mod something_deprecated {}
fn main() { som$0 }
"#,
SymbolKind::Module,
expect![[r#"
[
CompletionItem {
label: "something_deprecated::",
detail_left: None,
detail_right: None,
source_range: 55..58,
delete: 55..58,
insert: "something_deprecated::",
kind: SymbolKind(
Module,
),
lookup: "something_deprecated",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
#[deprecated]
fn something_deprecated() {}
fn main() { som$0 }
"#,
SymbolKind::Function,
expect![[r#"
[
CompletionItem {
label: "main()",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 56..59,
delete: 56..59,
insert: "main();$0",
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
CompletionItem {
label: "something_deprecated()",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 56..59,
delete: 56..59,
insert: "something_deprecated();$0",
kind: SymbolKind(
Function,
),
lookup: "something_deprecated",
detail: "fn()",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
#[deprecated]
struct A;
fn main() { A$0 }
"#,
SymbolKind::Struct,
expect![[r#"
[
CompletionItem {
label: "A",
detail_left: None,
detail_right: Some(
"A",
),
source_range: 37..38,
delete: 37..38,
insert: "A",
kind: SymbolKind(
Struct,
),
detail: "A",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
#[deprecated]
enum A {}
fn main() { A$0 }
"#,
SymbolKind::Enum,
expect![[r#"
[
CompletionItem {
label: "A",
detail_left: None,
detail_right: Some(
"A",
),
source_range: 37..38,
delete: 37..38,
insert: "A",
kind: SymbolKind(
Enum,
),
detail: "A",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
enum A {
Okay,
#[deprecated]
Old,
}
fn main() { A::$0 }
"#,
SymbolKind::Variant,
expect![[r#"
[
CompletionItem {
label: "Okay",
detail_left: None,
detail_right: Some(
"Okay",
),
source_range: 64..64,
delete: 64..64,
insert: "Okay$0",
kind: SymbolKind(
Variant,
),
detail: "Okay",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: false,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
trigger_call_info: true,
},
CompletionItem {
label: "Old",
detail_left: None,
detail_right: Some(
"Old",
),
source_range: 64..64,
delete: 64..64,
insert: "Old$0",
kind: SymbolKind(
Variant,
),
detail: "Old",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: false,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
trigger_call_info: true,
},
]
"#]],
);
check(
r#"
#[deprecated]
const A: i32 = 0;
fn main() { A$0 }
"#,
SymbolKind::Const,
expect![[r#"
[
CompletionItem {
label: "A",
detail_left: Some(
" = 0",
),
detail_right: Some(
"i32",
),
source_range: 45..46,
delete: 45..46,
insert: "A",
kind: SymbolKind(
Const,
),
detail: "i32",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
#[deprecated]
static A: i32 = 0;
fn main() { A$0 }
"#,
SymbolKind::Static,
expect![[r#"
[
CompletionItem {
label: "A",
detail_left: None,
detail_right: Some(
"i32",
),
source_range: 46..47,
delete: 46..47,
insert: "A",
kind: SymbolKind(
Static,
),
detail: "i32",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
#[deprecated]
trait A {}
impl A$0
"#,
SymbolKind::Trait,
expect![[r#"
[
CompletionItem {
label: "A",
detail_left: None,
detail_right: None,
source_range: 31..32,
delete: 31..32,
insert: "A",
kind: SymbolKind(
Trait,
),
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
#[deprecated]
type A = i32;
fn main() { A$0 }
"#,
SymbolKind::TypeAlias,
expect![[r#"
[
CompletionItem {
label: "A",
detail_left: None,
detail_right: Some(
"i32",
),
source_range: 41..42,
delete: 41..42,
insert: "A",
kind: SymbolKind(
TypeAlias,
),
detail: "i32",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
#[deprecated]
macro_rules! a { _ => {}}
fn main() { a$0 }
"#,
SymbolKind::Macro,
expect![[r#"
[
CompletionItem {
label: "a!(…)",
detail_left: None,
detail_right: Some(
"macro_rules! a",
),
source_range: 53..54,
delete: 53..54,
insert: "a!($0)",
kind: SymbolKind(
Macro,
),
lookup: "a!",
detail: "macro_rules! a",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
check(
r#"
struct A { #[deprecated] the_field: u32 }
fn main() { A { the$0 } }
"#,
SymbolKind::Field,
expect![[r#"
[
CompletionItem {
label: "the_field",
detail_left: None,
detail_right: Some(
"u32",
),
source_range: 59..62,
delete: 59..62,
insert: "the_field",
kind: SymbolKind(
Field,
),
detail: "u32",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: true,
},
},
]
"#]],
);
}
#[test]
fn renders_docs() {
check_kinds(
r#"
struct S {
/// Field docs
foo:
}
impl S {
/// Method docs
fn bar(self) { self.$0 }
}"#,
&[
CompletionItemKind::SymbolKind(SymbolKind::Method),
CompletionItemKind::SymbolKind(SymbolKind::Field),
],
expect![[r#"
[
CompletionItem {
label: "bar()",
detail_left: None,
detail_right: Some(
"fn(self)",
),
source_range: 94..94,
delete: 94..94,
insert: "bar();$0",
kind: SymbolKind(
Method,
),
lookup: "bar",
detail: "fn(self)",
documentation: Documentation(
"Method docs",
),
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Other,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
},
CompletionItem {
label: "foo",
detail_left: None,
detail_right: Some(
"{unknown}",
),
source_range: 94..94,
delete: 94..94,
insert: "foo",
kind: SymbolKind(
Field,
),
detail: "{unknown}",
documentation: Documentation(
"Field docs",
),
},
]
"#]],
);
check_kinds(
r#"
use self::my$0;
/// mod docs
mod my { }
/// enum docs
enum E {
/// variant docs
V
}
use self::E::*;
"#,
&[
CompletionItemKind::SymbolKind(SymbolKind::Module),
CompletionItemKind::SymbolKind(SymbolKind::Variant),
CompletionItemKind::SymbolKind(SymbolKind::Enum),
],
expect![[r#"
[
CompletionItem {
label: "my",
detail_left: None,
detail_right: None,
source_range: 10..12,
delete: 10..12,
insert: "my",
kind: SymbolKind(
Module,
),
documentation: Documentation(
"mod docs",
),
},
CompletionItem {
label: "V",
detail_left: None,
detail_right: Some(
"V",
),
source_range: 10..12,
delete: 10..12,
insert: "V$0",
kind: SymbolKind(
Variant,
),
detail: "V",
documentation: Documentation(
"variant docs",
),
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: false,
has_self_param: false,
return_type: DirectConstructor,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
trigger_call_info: true,
},
CompletionItem {
label: "E",
detail_left: None,
detail_right: Some(
"E",
),
source_range: 10..12,
delete: 10..12,
insert: "E",
kind: SymbolKind(
Enum,
),
detail: "E",
documentation: Documentation(
"enum docs",
),
},
]
"#]],
)
}
#[test]
fn dont_render_attrs() {
check(
r#"
struct S;
impl S {
#[inline]
fn the_method(&self) { }
}
fn foo(s: S) { s.$0 }
"#,
SymbolKind::Method,
expect![[r#"
[
CompletionItem {
label: "the_method()",
detail_left: None,
detail_right: Some(
"fn(&self)",
),
source_range: 81..81,
delete: 81..81,
insert: "the_method();$0",
kind: SymbolKind(
Method,
),
lookup: "the_method",
detail: "fn(&self)",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Other,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
},
]
"#]],
)
}
#[test]
fn no_call_parens_if_fn_ptr_needed() {
cov_mark::check!(no_call_parens_if_fn_ptr_needed);
check_edit(
"foo",
r#"
fn foo(foo: u8, bar: u8) {}
struct ManualVtable { f: fn(u8, u8) }
fn main() -> ManualVtable {
ManualVtable { f: f$0 }
}
"#,
r#"
fn foo(foo: u8, bar: u8) {}
struct ManualVtable { f: fn(u8, u8) }
fn main() -> ManualVtable {
ManualVtable { f: foo }
}
"#,
);
check_edit(
"type",
r#"
struct RawIdentTable { r#type: u32 }
fn main() -> RawIdentTable {
RawIdentTable { t$0: 42 }
}
"#,
r#"
struct RawIdentTable { r#type: u32 }
fn main() -> RawIdentTable {
RawIdentTable { r#type: 42 }
}
"#,
);
}
#[test]
fn no_call_parens_if_param_with_fn_bounds() {
cov_mark::check!(no_call_parens_if_ty_with_fn_bounds);
check_edit(
"foo",
r#"
//- minicore: fn
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(f$0)
}
"#,
r#"
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(foo)
}
"#,
);
check_edit(
"foo",
r#"
//- minicore: fn
fn needs_fn<F: FnOnce(u8, u8)>(f: F) {}
fn foo(a: u8, b: u8) {
needs_fn(f$0)
}
"#,
r#"
fn needs_fn<F: FnOnce(u8, u8)>(f: F) {}
fn foo(a: u8, b: u8) {
needs_fn(foo)
}
"#,
);
check_edit(
"foo",
r#"
//- minicore: fn
fn needs_fn<F>(f: F) where F: FnOnce(u8, u8) {}
fn foo(a: u8, b: u8) {
needs_fn(f$0)
}
"#,
r#"
fn needs_fn<F>(f: F) where F: FnOnce(u8, u8) {}
fn foo(a: u8, b: u8) {
needs_fn(foo)
}
"#,
);
check_edit(
"unmap",
r#"
//- minicore: fn
trait Trait {
fn unmap(self) -> i32 { 0 }
}
mod module {
pub struct Ty;
impl super::Trait for Ty {}
}
fn needs_fn<T>(f: impl FnOnce(T) -> i32) {}
fn foo(a: u8, b: u8) {
needs_fn(module::Ty::u$0)
}
"#,
r#"
trait Trait {
fn unmap(self) -> i32 { 0 }
}
mod module {
pub struct Ty;
impl super::Trait for Ty {}
}
fn needs_fn<T>(f: impl FnOnce(T) -> i32) {}
fn foo(a: u8, b: u8) {
needs_fn(module::Ty::unmap)
}
"#,
);
check_edit(
"neg",
r#"
//- minicore: iterator, iterators, unary_ops, builtin_impls
fn foo(iter: impl Iterator<Item = u32>) {
iter.map(core::ops::Neg::n$0)
}
"#,
r#"
fn foo(iter: impl Iterator<Item = u32>) {
iter.map(core::ops::Neg::neg)
}
"#,
);
}
#[test]
fn call_parens_in_non_direct_expr() {
check_edit(
"foo",
r#"
//- minicore: fn
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(&f$0)
}
"#,
r#"
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(&foo(${1:a}, ${2:b})$0)
}
"#,
);
check_edit(
"method",
r#"
//- minicore: fn
struct Foo;
impl Foo { fn method(&self, a: u8, b: u8) {} }
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(Foo.m$0)
}
"#,
r#"
struct Foo;
impl Foo { fn method(&self, a: u8, b: u8) {} }
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(Foo.method(${1:a}, ${2:b})$0)
}
"#,
);
check_edit(
"method",
r#"
//- minicore: fn
struct Foo;
impl Foo { fn method(&self, a: u8, b: u8) {} }
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(Foo.$0)
}
"#,
r#"
struct Foo;
impl Foo { fn method(&self, a: u8, b: u8) {} }
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8, b: u8) {
needs_fn(Foo.method(${1:a}, ${2:b})$0)
}
"#,
);
}
#[test]
fn call_parens_in_bad_case() {
check_edit(
"foo",
r#"
//- minicore: fn
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8) {
needs_fn(f$0);
}
"#,
r#"
fn needs_fn(f: impl FnOnce(u8, u8)) {}
fn foo(a: u8) {
needs_fn(foo(${1:a})$0);
}
"#,
);
check_edit(
"foo",
r#"
//- minicore: fn
fn needs_fn<T>(f: impl FnOnce(u8, u8) -> T) {}
fn foo(a: u8, b: u8) -> impl FnOnce(u8, u8) {
needs_fn(f$0);
}
"#,
r#"
fn needs_fn<T>(f: impl FnOnce(u8, u8) -> T) {}
fn foo(a: u8, b: u8) -> impl FnOnce(u8, u8) {
needs_fn(foo(${1:a}, ${2:b})$0);
}
"#,
);
check_edit(
"foo",
r#"
//- minicore: fn
fn needs_fn(f: impl FnOnce(u8, u8) -> u8) {}
fn foo(a: u8, b: u8) -> u16 {
needs_fn(f$0);
}
"#,
r#"
fn needs_fn(f: impl FnOnce(u8, u8) -> u8) {}
fn foo(a: u8, b: u8) -> u16 {
needs_fn(foo(${1:a}, ${2:b})$0);
}
"#,
);
}
#[test]
fn no_parens_in_use_item() {
check_edit(
"foo",
r#"
mod m { pub fn foo() {} }
use crate::m::f$0;
"#,
r#"
mod m { pub fn foo() {} }
use crate::m::foo;
"#,
);
}
#[test]
fn no_parens_in_call() {
check_edit(
"foo",
r#"
fn foo(x: i32) {}
fn main() { f$0(); }
"#,
r#"
fn foo(x: i32) {}
fn main() { foo(); }
"#,
);
check_edit(
"foo",
r#"
struct Foo;
impl Foo { fn foo(&self){} }
fn f(foo: &Foo) { foo.f$0(); }
"#,
r#"
struct Foo;
impl Foo { fn foo(&self){} }
fn f(foo: &Foo) { foo.foo(); }
"#,
);
}
#[test]
fn inserts_angle_brackets_for_generics() {
cov_mark::check!(inserts_angle_brackets_for_generics);
check_edit(
"Vec",
r#"
struct Vec<T> {}
fn foo(xs: Ve$0)
"#,
r#"
struct Vec<T> {}
fn foo(xs: Vec<$0>)
"#,
);
check_edit(
"Vec",
r#"
type Vec<T> = (T,);
fn foo(xs: Ve$0)
"#,
r#"
type Vec<T> = (T,);
fn foo(xs: Vec<$0>)
"#,
);
check_edit(
"Vec",
r#"
struct Vec<T = i128> {}
fn foo(xs: Ve$0)
"#,
r#"
struct Vec<T = i128> {}
fn foo(xs: Vec)
"#,
);
check_edit(
"Vec",
r#"
struct Vec<T> {}
fn foo(xs: Ve$0<i128>)
"#,
r#"
struct Vec<T> {}
fn foo(xs: Vec<i128>)
"#,
);
}
#[test]
fn active_param_relevance() {
check_relevance(
r#"
struct S { foo: i64, bar: u32, baz: u32 }
fn test(bar: u32) { }
fn foo(s: S) { test(s.$0) }
"#,
expect![[r#"
fd bar u32 [type+name]
fd baz u32 [type]
fd foo i64 []
"#]],
);
}
#[test]
fn record_field_relevances() {
check_relevance(
r#"
struct A { foo: i64, bar: u32, baz: u32 }
struct B { x: (), y: f32, bar: u32 }
fn foo(a: A) { B { bar: a.$0 }; }
"#,
expect![[r#"
fd bar u32 [type+name]
fd baz u32 [type]
fd foo i64 []
"#]],
)
}
#[test]
fn tuple_field_detail() {
check(
r#"
struct S(i32);
fn f() -> i32 {
let s = S(0);
s.0$0
}
"#,
SymbolKind::Field,
expect![[r#"
[
CompletionItem {
label: "0",
detail_left: None,
detail_right: Some(
"i32",
),
source_range: 56..57,
delete: 56..57,
insert: "0",
kind: SymbolKind(
Field,
),
detail: "i32",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: Some(
Exact,
),
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
},
]
"#]],
);
}
#[test]
fn record_field_and_call_relevances() {
check_relevance(
r#"
struct A { foo: i64, bar: u32, baz: u32 }
struct B { x: (), y: f32, bar: u32 }
fn f(foo: i64) { }
fn foo(a: A) { B { bar: f(a.$0) }; }
"#,
expect![[r#"
fd foo i64 [type+name]
fd bar u32 []
fd baz u32 []
"#]],
);
check_relevance(
r#"
struct A { foo: i64, bar: u32, baz: u32 }
struct B { x: (), y: f32, bar: u32 }
fn f(foo: i64) { }
fn foo(a: A) { f(B { bar: a.$0 }); }
"#,
expect![[r#"
fd bar u32 [type+name]
fd baz u32 [type]
fd foo i64 []
"#]],
);
}
#[test]
fn prioritize_exact_ref_match() {
check_relevance(
r#"
struct WorldSnapshot { _f: () };
fn go(world: &WorldSnapshot) { go(w$0) }
"#,
expect![[r#"
lc world &WorldSnapshot [type+name+local]
ex world [type]
st WorldSnapshot {…} WorldSnapshot { _f: () } []
st &WorldSnapshot {…} [type]
st WorldSnapshot WorldSnapshot []
fn go(…) fn(&WorldSnapshot) []
"#]],
);
}
#[test]
fn prioritize_mutable_ref_as_immutable_ref_match() {
check_relevance(
r#"fn foo(r: &mut i32) -> &i32 { $0 }"#,
expect![[r#"
lc r &mut i32 [type+local]
fn foo(…) fn(&mut i32) -> &i32 [type]
"#]],
);
}
#[test]
fn complete_ref_match_after_keyword_prefix() {
// About https://github.com/rust-lang/rust-analyzer/issues/15139
check_kinds(
r#"
fn foo(data: &i32) {}
fn main() {
let indent = 2i32;
foo(in$0)
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Local)],
expect![[r#"
[
CompletionItem {
label: "indent",
detail_left: None,
detail_right: Some(
"i32",
),
source_range: 65..67,
delete: 65..67,
insert: "indent",
kind: SymbolKind(
Local,
),
detail: "i32",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: true,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
ref_match: "&@65",
},
]
"#]],
);
}
#[test]
fn complete_ref_match_in_macro() {
check_kinds(
r#"
macro_rules! id { ($($t:tt)*) => ($($t)*); }
fn foo(data: &i32) {}
fn main() {
let indent = 2i32;
id!(foo(i$0))
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Local)],
expect![[r#"
[
CompletionItem {
label: "indent",
detail_left: None,
detail_right: Some(
"i32",
),
source_range: 114..115,
delete: 114..115,
insert: "indent",
kind: SymbolKind(
Local,
),
detail: "i32",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: true,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
ref_match: "&@114",
},
]
"#]],
);
check_kinds(
r#"
macro_rules! id { ($($t:tt)*) => ($($t)*); }
fn foo(data: &i32) {}
fn indent() -> i32 { i32 }
fn main() {
id!(foo(i$0))
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Function)],
expect![[r#"
[
CompletionItem {
label: "foo(…)",
detail_left: None,
detail_right: Some(
"fn(&i32)",
),
source_range: 118..119,
delete: 118..119,
insert: "foo(${1:data})$0",
kind: SymbolKind(
Function,
),
lookup: "foo",
detail: "fn(&i32)",
trigger_call_info: true,
},
CompletionItem {
label: "indent()",
detail_left: None,
detail_right: Some(
"fn() -> i32",
),
source_range: 118..119,
delete: 118..119,
insert: "indent()$0",
kind: SymbolKind(
Function,
),
lookup: "indent",
detail: "fn() -> i32",
ref_match: "&@118",
},
CompletionItem {
label: "main()",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 118..119,
delete: 118..119,
insert: "main()$0",
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
]
"#]],
);
// FIXME: It is best to test `S.in` if speculative execution is implemented
check_kinds(
r#"
macro_rules! id { ($($t:tt)*) => ($($t)*); }
fn foo(data: &i32) {}
struct S;
impl S {fn indent(&self) -> i32 { i32 }}
fn main() {
id!(foo(S.i$0))
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Method)],
expect![[r#"
[
CompletionItem {
label: "indent()",
detail_left: None,
detail_right: Some(
"fn(&self) -> i32",
),
source_range: 144..145,
delete: 144..145,
insert: "indent()$0",
kind: SymbolKind(
Method,
),
lookup: "indent",
detail: "fn(&self) -> i32",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Other,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
ref_match: "&@142",
},
]
"#]],
);
check_kinds(
r#"
macro_rules! id { ($($t:tt)*) => ($($t)*); }
fn foo(data: &i32) {}
struct S { indent: i32 }
fn main(s: S) {
id!(foo(s.i$0))
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Field)],
expect![[r#"
[
CompletionItem {
label: "indent",
detail_left: None,
detail_right: Some(
"i32",
),
source_range: 122..123,
delete: 122..123,
insert: "indent",
kind: SymbolKind(
Field,
),
detail: "i32",
ref_match: "&@120",
},
]
"#]],
);
}
#[test]
fn too_many_arguments() {
cov_mark::check!(too_many_arguments);
check_relevance(
r#"
struct Foo;
fn f(foo: &Foo) { f(foo, w$0) }
"#,
expect![[r#"
lc foo &Foo [local]
st Foo Foo []
fn f(…) fn(&Foo) []
"#]],
);
}
#[test]
fn score_fn_type_and_name_match() {
check_relevance(
r#"
struct A { bar: u8 }
fn baz() -> u8 { 0 }
fn bar() -> u8 { 0 }
fn f() { A { bar: b$0 }; }
"#,
expect![[r#"
fn bar() fn() -> u8 [type+name]
ex bar() [type]
fn baz() fn() -> u8 [type]
ex baz() [type]
st A A []
fn f() fn() []
"#]],
);
}
#[test]
fn score_method_type_and_name_match() {
check_relevance(
r#"
fn baz(aaa: u32){}
struct Foo;
impl Foo {
fn aaa(&self) -> u32 { 0 }
fn bbb(&self) -> u32 { 0 }
fn ccc(&self) -> u64 { 0 }
}
fn f() {
baz(Foo.$0
}
"#,
expect![[r#"
me aaa() fn(&self) -> u32 [type+name]
me bbb() fn(&self) -> u32 [type]
me ccc() fn(&self) -> u64 []
"#]],
);
}
#[test]
fn score_method_name_match_only() {
check_relevance(
r#"
fn baz(aaa: u32){}
struct Foo;
impl Foo {
fn aaa(&self) -> u64 { 0 }
}
fn f() {
baz(Foo.$0
}
"#,
expect![[r#"
me aaa() fn(&self) -> u64 [name]
"#]],
);
}
#[test]
fn name_match_special_case() {
check_relevance(
r#"
fn foo(_db: &()) {}
fn bar(db: &()) {
foo($0)
}
"#,
expect![[r#"
lc db &() [type+name+local]
ex db [type]
fn bar(…) fn(&()) []
fn foo(…) fn(&()) []
"#]],
);
check_relevance(
r#"
fn foo(impl_: &()) {}
fn bar(r#impl: &()) {
foo($0)
}
"#,
expect![[r#"
lc impl &() [type+name+local]
ex r#impl [type]
fn bar(…) fn(&()) []
fn foo(…) fn(&()) []
"#]],
);
check_relevance(
r#"
fn foo(r#impl: &()) {}
fn bar(impl_: &()) {
foo($0)
}
"#,
expect![[r#"
lc impl_ &() [type+name+local]
ex impl_ [type]
fn bar(…) fn(&()) []
fn foo(…) fn(&()) []
"#]],
);
}
#[test]
fn score_has_local_inherent_impl() {
check_relevance(
r#"
trait Foob {}
struct Fooa {}
impl Fooa {}
impl Foo$0
"#,
expect![[r#"
tt Foob []
st Fooa Fooa [has_local_inherent_impl]
"#]],
);
// inherent impl in different modules, not trigger `has_local_inherent_impl`
check_relevance(
r#"
trait Foob {}
struct Fooa {}
mod a {
use super::*;
impl Fooa {}
}
mod b {
use super::*;
impl Foo$0
}
"#,
expect![[r#"
st Fooa Fooa []
tt Foob []
md a:: []
md b:: []
"#]],
);
}
#[test]
fn score_patterns() {
check_relevance(
r#"
struct Foo(Bar);
struct Bar { field: i32 }
fn go(Foo($0): Foo) {}
"#,
expect![[r#"
bn Bar {…} Bar { field$1 }$0 [type]
st Bar []
st Foo []
bn Foo(…) Foo($1)$0 []
"#]],
);
check_relevance(
r#"
struct Foo(Bar);
enum Bar { Variant { field: i32 } }
fn go(foo: Foo) { match foo { Foo($0) } }
"#,
expect![[r#"
bn Bar::Variant {…} Bar::Variant { field$1 }$0 [type]
en Bar []
st Foo []
bn Foo(…) Foo($1)$0 []
"#]],
);
}
#[test]
fn not_type_match_useless_types() {
check_relevance(
r#"
fn foo() -> Unknown {}
fn test() {
let unit = ();
let unknown = unknown;
let _: () = $0;
}
"#,
expect![[r#"
lc unit () [local]
fn foo() fn() -> {unknown} []
fn test() fn() []
"#]],
);
check_relevance(
r#"
fn foo() -> Unknown {}
fn test() {
let unit = ();
let unknown = unknown;
let _ = $0;
}
"#,
expect![[r#"
lc unit () [local]
fn foo() fn() -> {unknown} []
fn test() fn() []
"#]],
);
check_relevance(
r#"
struct Matches;
impl Matches {
fn opt_present(&self) -> bool {}
}
mod module {
pub fn max<T>(a: T, b: T) -> T {}
pub fn min<T>(a: T, b: T) -> T {}
}
use module::max;
fn test(matches: &Matches) {
if m$0
}
"#,
expect![[r#"
ex false [type]
ex true [type]
lc matches &Matches [local]
st Matches Matches []
fn max(…) fn(T, T) -> T []
md module:: []
fn test(…) fn(&Matches) []
fn min(…) fn(T, T) -> T [requires_import]
"#]],
);
}
#[test]
fn test_avoid_redundant_suggestion() {
check_relevance(
r#"
struct aa([u8]);
impl aa {
fn from_bytes(bytes: &[u8]) -> &Self {
unsafe { &*(bytes as *const [u8] as *const aa) }
}
}
fn bb()-> &'static aa {
let bytes = b"hello";
aa::$0
}
"#,
expect![[r#"
fn from_bytes(…) fn(&[u8]) -> &aa [type_could_unify]
"#]],
);
}
#[test]
fn suggest_ref_mut() {
cov_mark::check!(suggest_ref);
check_relevance(
r#"
struct S;
fn foo(s: &mut S) {}
fn main() {
let mut s = S;
foo($0);
}
"#,
expect![[r#"
lc s S [name+local]
lc &mut s [type+name+local]
st S S []
st &mut S [type]
st S S []
fn foo(…) fn(&mut S) []
fn main() fn() []
"#]],
);
check_relevance(
r#"
struct S;
fn foo(s: &mut S) {}
fn main() {
let mut s = S;
foo(&mut $0);
}
"#,
// FIXME: There are many `S` here
expect![[r#"
lc s S [type+name+local]
st S S [type]
st S S [type]
ex S [type]
ex s [type]
fn foo(…) fn(&mut S) []
fn main() fn() []
"#]],
);
check_relevance(
r#"
struct S;
fn foo(s: &mut S) {}
fn main() {
let mut ssss = S;
foo(&mut s$0);
}
"#,
expect![[r#"
st S S [type]
lc ssss S [type+local]
st S S [type]
ex S [type]
ex ssss [type]
fn foo(…) fn(&mut S) []
fn main() fn() []
"#]],
);
check_relevance(
r#"
struct S;
fn foo(s: &&S) {}
fn main() {
let mut ssss = &S;
foo($0);
}
"#,
expect![[r#"
st S S []
lc ssss &S [local]
lc &ssss [type+local]
st S S []
fn foo(…) fn(&&S) []
fn main() fn() []
"#]],
);
check_relevance(
r#"
struct S<T>(T);
fn foo<T>(s: &mut S<T>) {}
fn main() {
let mut ssss = S(2u32);
foo($0);
}
"#,
expect![[r#"
st S(…) S(T) []
st &mut S(…) [type]
lc ssss S<u32> [local]
lc &mut ssss [type+local]
st S S<T> []
fn foo(…) fn(&mut S<T>) []
fn main() fn() []
"#]],
);
check_relevance(
r#"
struct S { info: u32 }
impl S {
fn info(&self) -> u32 { self.info }
fn foo(&self) {
needs(i$0);
}
}
fn needs(info: &mut u32) {}
"#,
expect![[r#"
fd self.info u32 [name]
fd &mut self.info [type+name]
me self.info() fn(&self) -> u32 [name]
me &mut self.info() [type+name]
lc self &S [local]
st S S []
sp Self S []
fn needs(…) fn(&mut u32) []
me self.foo() fn(&self) []
"#]],
);
// Regression test https://github.com/rust-lang/rust-analyzer/issues/22324
check_relevance(
r#"
//- minicore: deref
struct S<T>(T);
impl<T> core::ops::Deref for S<T> {
type Target = T;
}
fn foo<T>(s: &u32) {}
fn main() {
let ssss = S();
foo($0);
}
"#,
expect![[r#"
lc ssss S<{unknown}> [local]
st S S<T> []
md core:: []
fn foo(…) fn(&u32) []
fn main() fn() []
"#]],
);
check_relevance(
r#"
//- minicore: deref
fn foo<T>(s: &T) {}
fn main() {
let ssss = &mut 2i32;
foo($0);
}
"#,
expect![[r#"
lc ssss &mut i32 [type_could_unify+local]
md core:: []
fn foo(…) fn(&T) []
fn main() fn() []
"#]],
);
}
#[test]
fn suggest_deref_copy() {
cov_mark::check!(suggest_deref);
check_relevance(
r#"
//- minicore: copy
struct Foo;
impl Copy for Foo {}
impl Clone for Foo {
fn clone(&self) -> Self { *self }
}
fn bar(x: Foo) {}
fn main() {
let foo = &Foo;
bar($0);
}
"#,
expect![[r#"
st Foo Foo [type]
st Foo Foo [type]
ex Foo [type]
lc foo &Foo [local]
lc *foo [type+local]
tt Clone []
tt Copy []
fn bar(…) fn(Foo) []
md core:: []
fn main() fn() []
"#]],
);
}
#[test]
fn suggest_deref_trait() {
check_relevance(
r#"
//- minicore: deref
struct S;
struct T(S);
impl core::ops::Deref for T {
type Target = S;
fn deref(&self) -> &Self::Target {
&self.0
}
}
fn foo(s: &S) {}
fn main() {
let t = T(S);
let m = 123;
foo($0);
}
"#,
expect![[r#"
st S S []
st &S [type]
ex core::ops::Deref::deref(&t) [type_could_unify]
lc m i32 [local]
lc t T [local]
lc &t [type+local]
st S S []
st T T []
md core:: []
fn foo(…) fn(&S) []
fn main() fn() []
"#]],
)
}
#[test]
fn suggest_deref_mut() {
check_relevance(
r#"
//- minicore: deref_mut
struct S;
struct T(S);
impl core::ops::Deref for T {
type Target = S;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl core::ops::DerefMut for T {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
fn foo(s: &mut S) {}
fn main() {
let t = T(S);
let m = 123;
foo($0);
}
"#,
expect![[r#"
st S S []
st &mut S [type]
ex core::ops::DerefMut::deref_mut(&mut t) [type_could_unify]
lc m i32 [local]
lc t T [local]
lc &mut t [type+local]
st S S []
st T T []
md core:: []
fn foo(…) fn(&mut S) []
fn main() fn() []
"#]],
)
}
#[test]
fn locals() {
check_relevance(
r#"
fn foo(bar: u32) {
let baz = 0;
f$0
}
"#,
expect![[r#"
lc bar u32 [local]
lc baz i32 [local]
fn foo(…) fn(u32) []
"#]],
);
}
#[test]
fn enum_owned() {
check_relevance(
r#"
enum Foo { A, B }
fn foo() {
bar($0);
}
fn bar(t: Foo) {}
"#,
expect![[r#"
ev Foo::A Foo::A [type]
ev Foo::B Foo::B [type]
en Foo Foo [type]
ex Foo::A [type]
ex Foo::B [type]
fn bar(…) fn(Foo) []
fn foo() fn() []
"#]],
);
}
#[test]
fn enum_ref() {
check_relevance(
r#"
enum Foo { A, B }
fn foo() {
bar($0);
}
fn bar(t: &Foo) {}
"#,
expect![[r#"
ev Foo::A Foo::A []
ev &Foo::A [type]
ev Foo::B Foo::B []
ev &Foo::B [type]
en Foo Foo []
fn bar(…) fn(&Foo) []
fn foo() fn() []
"#]],
);
}
#[test]
fn suggest_deref_fn_ret() {
check_relevance(
r#"
//- minicore: deref
struct S;
struct T(S);
impl core::ops::Deref for T {
type Target = S;
fn deref(&self) -> &Self::Target {
&self.0
}
}
fn foo(s: &S) {}
fn bar() -> T {}
fn main() {
foo($0);
}
"#,
expect![[r#"
st S S []
st &S [type]
ex core::ops::Deref::deref(&bar()) [type_could_unify]
st S S []
st T T []
fn bar() fn() -> T []
fn &bar() [type]
md core:: []
fn foo(…) fn(&S) []
fn main() fn() []
"#]],
)
}
#[test]
fn op_function_relevances() {
check_relevance(
r#"
#[lang = "sub"]
trait Sub {
fn sub(self, other: Self) -> Self { self }
}
impl Sub for u32 {}
fn foo(a: u32) { a.$0 }
"#,
expect![[r#"
me sub(…) fn(self, Self) -> Self [op_method]
"#]],
);
check_relevance(
r#"
struct Foo;
impl Foo {
fn new() -> Self {}
}
#[lang = "eq"]
pub trait PartialEq<Rhs: ?Sized = Self> {
fn eq(&self, other: &Rhs) -> bool;
fn ne(&self, other: &Rhs) -> bool;
}
impl PartialEq for Foo {}
fn main() {
Foo::$0
}
"#,
expect![[r#"
fn new() fn() -> Foo []
me eq(…) fn(&self, &Rhs) -> bool [op_method]
me ne(…) fn(&self, &Rhs) -> bool [op_method]
"#]],
);
}
#[test]
fn constructor_order_simple() {
check_relevance(
r#"
struct Foo;
struct Other;
struct Option<T>(T);
impl Foo {
fn fn_ctr() -> Foo { unimplemented!() }
fn fn_another(n: u32) -> Other { unimplemented!() }
fn fn_ctr_self() -> Option<Self> { unimplemented!() }
}
fn test() {
let a = Foo::$0;
}
"#,
expect![[r#"
fn fn_ctr() fn() -> Foo []
fn fn_ctr_self() fn() -> Option<Foo> []
fn fn_another(…) fn(u32) -> Other []
"#]],
);
}
#[test]
fn trait_items_order() {
check_relevance(
r#"
trait T{
fn a_optional() {}
fn b_required();
}
impl T for (){
$0
}
"#,
expect![[r#"
fn fn b_required() [name+missing]
fn fn a_optional() [name]
"#]],
);
check_relevance(
r#"
trait T{
type Item;
fn optional() {}
}
impl T for (){
$0
}
"#,
expect![[r#"
ta type Item = [name+missing]
fn fn optional() [name]
"#]],
);
check_relevance(
r#"
trait T{
const A: usize = 0;
const B: usize;
}
impl T for (){
$0
}
"#,
expect![[r#"
ct const B: usize = [name+missing]
ct const A: usize = [name]
"#]],
);
}
#[test]
fn constructor_order_kind() {
check_function_relevance(
r#"
struct Foo;
struct Bar;
struct Option<T>(T);
enum Result<T, E> { Ok(T), Err(E) };
impl Foo {
fn fn_ctr(&self) -> Foo { unimplemented!() }
fn fn_ctr_with_args(&self, n: u32) -> Foo { unimplemented!() }
fn fn_another(&self, n: u32) -> Bar { unimplemented!() }
fn fn_ctr_wrapped(&self, ) -> Option<Self> { unimplemented!() }
fn fn_ctr_wrapped_2(&self, ) -> Result<Self, Bar> { unimplemented!() }
fn fn_ctr_wrapped_3(&self, ) -> Result<Bar, Self> { unimplemented!() } // Self is not the first type
fn fn_ctr_wrapped_with_args(&self, m: u32) -> Option<Self> { unimplemented!() }
fn fn_another_unit(&self) { unimplemented!() }
}
fn test() {
let a = self::Foo::$0;
}
"#,
expect![[r#"
[
(
"fn(&self, u32) -> Bar",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Other,
},
),
),
(
"fn(&self)",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Other,
},
),
),
(
"fn(&self) -> Foo",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: DirectConstructor,
},
),
),
(
"fn(&self, u32) -> Foo",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: DirectConstructor,
},
),
),
(
"fn(&self) -> Option<Foo>",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Constructor,
},
),
),
(
"fn(&self) -> Result<Foo, Bar>",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Constructor,
},
),
),
(
"fn(&self) -> Result<Bar, Foo>",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Constructor,
},
),
),
(
"fn(&self, u32) -> Option<Foo>",
Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Constructor,
},
),
),
]
"#]],
);
}
#[test]
fn constructor_order_relevance() {
check_relevance(
r#"
struct Foo;
struct FooBuilder;
struct Result<T>(T);
impl Foo {
fn fn_no_ret(&self) {}
fn fn_ctr_with_args(input: u32) -> Foo { unimplemented!() }
fn fn_direct_ctr() -> Self { unimplemented!() }
fn fn_ctr() -> Result<Self> { unimplemented!() }
fn fn_other() -> Result<u32> { unimplemented!() }
fn fn_builder() -> FooBuilder { unimplemented!() }
}
fn test() {
let a = self::Foo::$0;
}
"#,
// preference:
// Direct Constructor
// Direct Constructor with args
// Builder
// Constructor
// Others
expect![[r#"
fn fn_direct_ctr() fn() -> Foo []
fn fn_ctr_with_args(…) fn(u32) -> Foo []
fn fn_builder() fn() -> FooBuilder []
fn fn_ctr() fn() -> Result<Foo> []
me fn_no_ret(…) fn(&self) []
fn fn_other() fn() -> Result<u32> []
"#]],
);
//
}
#[test]
fn function_relevance_generic_1() {
check_relevance(
r#"
struct Foo<T: Default>(T);
struct FooBuilder;
struct Option<T>(T);
enum Result<T, E>{Ok(T), Err(E)};
impl<T: Default> Foo<T> {
fn fn_returns_unit(&self) {}
fn fn_ctr_with_args(input: T) -> Foo<T> { unimplemented!() }
fn fn_direct_ctr() -> Self { unimplemented!() }
fn fn_ctr_wrapped() -> Option<Self> { unimplemented!() }
fn fn_ctr_wrapped_2() -> Result<Self, u32> { unimplemented!() }
fn fn_other() -> Option<u32> { unimplemented!() }
fn fn_builder() -> FooBuilder { unimplemented!() }
}
fn test() {
let a = self::Foo::<u32>::$0;
}
"#,
expect![[r#"
fn fn_direct_ctr() fn() -> Foo<T> []
fn fn_ctr_with_args(…) fn(T) -> Foo<T> []
fn fn_builder() fn() -> FooBuilder []
fn fn_ctr_wrapped() fn() -> Option<Foo<T>> []
fn fn_ctr_wrapped_2() fn() -> Result<Foo<T>, u32> []
fn fn_other() fn() -> Option<u32> []
me fn_returns_unit(…) fn(&self) []
"#]],
);
}
#[test]
fn function_relevance_generic_2() {
// Generic 2
check_relevance(
r#"
struct Foo<T: Default>(T);
struct FooBuilder;
struct Option<T>(T);
enum Result<T, E>{Ok(T), Err(E)};
impl<T: Default> Foo<T> {
fn fn_no_ret(&self) {}
fn fn_ctr_with_args(input: T) -> Foo<T> { unimplemented!() }
fn fn_direct_ctr() -> Self { unimplemented!() }
fn fn_ctr() -> Option<Self> { unimplemented!() }
fn fn_ctr2() -> Result<Self, u32> { unimplemented!() }
fn fn_other() -> Option<u32> { unimplemented!() }
fn fn_builder() -> FooBuilder { unimplemented!() }
}
fn test() {
let a : Res<Foo<u32>> = Foo::$0;
}
"#,
expect![[r#"
fn fn_direct_ctr() fn() -> Foo<T> []
fn fn_ctr_with_args(…) fn(T) -> Foo<T> []
fn fn_builder() fn() -> FooBuilder []
fn fn_ctr() fn() -> Option<Foo<T>> []
fn fn_ctr2() fn() -> Result<Foo<T>, u32> []
me fn_no_ret(…) fn(&self) []
fn fn_other() fn() -> Option<u32> []
"#]],
);
}
#[test]
fn struct_field_method_ref() {
check_kinds(
r#"
struct Foo { bar: u32, qux: fn() }
impl Foo { fn baz(&self) -> u32 { 0 } }
fn foo(f: Foo) { let _: &u32 = f.b$0 }
"#,
&[
CompletionItemKind::SymbolKind(SymbolKind::Method),
CompletionItemKind::SymbolKind(SymbolKind::Field),
],
expect![[r#"
[
CompletionItem {
label: "baz()",
detail_left: None,
detail_right: Some(
"fn(&self) -> u32",
),
source_range: 109..110,
delete: 109..110,
insert: "baz()$0",
kind: SymbolKind(
Method,
),
lookup: "baz",
detail: "fn(&self) -> u32",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: true,
has_self_param: true,
return_type: Other,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
ref_match: "&@107",
},
CompletionItem {
label: "bar",
detail_left: None,
detail_right: Some(
"u32",
),
source_range: 109..110,
delete: 109..110,
insert: "bar",
kind: SymbolKind(
Field,
),
detail: "u32",
ref_match: "&@107",
},
CompletionItem {
label: "qux",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 109..110,
text_edit: TextEdit {
indels: [
Indel {
insert: "(",
delete: 107..107,
},
Indel {
insert: "qux)()",
delete: 109..110,
},
],
annotation: None,
},
kind: SymbolKind(
Field,
),
detail: "fn()",
},
]
"#]],
);
}
#[test]
fn expected_fn_type_ref() {
check_kinds(
r#"
struct S { field: fn() }
fn foo() {
let foo: fn() = S { fields: || {}}.fi$0;
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Field)],
expect![[r#"
[
CompletionItem {
label: "field",
detail_left: None,
detail_right: Some(
"fn()",
),
source_range: 76..78,
delete: 76..78,
insert: "field",
kind: SymbolKind(
Field,
),
detail: "fn()",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: Some(
Exact,
),
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
},
]
"#]],
)
}
#[test]
fn qualified_path_ref() {
check_kinds(
r#"
struct S;
struct T;
impl T {
fn foo() -> S {}
}
fn bar(s: &S) {}
fn main() {
bar(T::$0);
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Function)],
expect![[r#"
[
CompletionItem {
label: "foo()",
detail_left: None,
detail_right: Some(
"fn() -> S",
),
source_range: 95..95,
delete: 95..95,
insert: "foo()$0",
kind: SymbolKind(
Function,
),
lookup: "foo",
detail: "fn() -> S",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: None,
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: Some(
CompletionRelevanceFn {
has_params: false,
has_self_param: false,
return_type: Other,
},
),
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
ref_match: "&@92",
},
]
"#]],
);
}
#[test]
fn generic_enum() {
check_relevance(
r#"
enum Foo<T> { A(T), B }
// bar() should not be an exact type match
// because the generic parameters are different
fn bar() -> Foo<u8> { Foo::B }
// FIXME baz() should be an exact type match
// because the types could unify, but it currently
// is not. This is due to the T here being
// TyKind::Placeholder rather than TyKind::Missing.
fn baz<T>() -> Foo<T> { Foo::B }
fn foo() {
let foo: Foo<u32> = Foo::B;
let _: Foo<u32> = f$0;
}
"#,
expect![[r#"
lc foo Foo<u32> [type+local]
ex Foo::B [type]
ex foo [type]
ev Foo::B Foo::B [type_could_unify]
ev Foo::A(…) Foo::A(T) [type_could_unify]
en Foo Foo<T> [type_could_unify]
fn baz() fn() -> Foo<T> [type_could_unify]
fn bar() fn() -> Foo<u8> []
fn foo() fn() []
"#]],
);
}
#[test]
fn postfix_exact_match_is_high_priority() {
cov_mark::check!(postfix_exact_match_is_high_priority);
check_relevance_for_kinds(
r#"
mod ops {
pub trait Not {
type Output;
fn not(self) -> Self::Output;
}
impl Not for bool {
type Output = bool;
fn not(self) -> bool { if self { false } else { true }}
}
}
fn main() {
let _: bool = (9 > 2).not$0;
}
"#,
&[CompletionItemKind::Snippet, CompletionItemKind::SymbolKind(SymbolKind::Method)],
expect![[r#"
sn not !expr [snippet]
me not() fn(self) -> <Self as Not>::Output [type_could_unify+requires_import]
sn box Box::new(expr) []
sn call function(expr) []
sn const const {} []
sn dbg dbg!(expr) []
sn dbgr dbg!(&expr) []
sn deref *expr []
sn if if expr {} []
sn match match expr {} []
sn ref &expr []
sn refm &mut expr []
sn return return expr []
sn unsafe unsafe {} []
sn while while expr {} []
"#]],
);
}
#[test]
fn enum_variant_name_exact_match_is_high_priority() {
check_relevance(
r#"
struct Other;
struct String;
enum Foo {
String($0)
}
"#,
expect![[r#"
st String String [name]
en Foo Foo []
st Other Other []
sp Self Foo []
"#]],
);
check_relevance(
r#"
struct Other;
struct String;
enum Foo {
String(String, $0)
}
"#,
expect![[r#"
en Foo Foo []
st Other Other []
sp Self Foo []
st String String []
"#]],
);
check_relevance(
r#"
struct Other;
struct Vec<T>(T);
enum Foo {
Vec(Vec<$0>)
}
"#,
expect![[r#"
en Foo Foo []
st Other Other []
sp Self Foo []
st Vec<…> Vec<T> []
"#]],
);
}
#[test]
fn postfix_inexact_match_is_low_priority() {
cov_mark::check!(postfix_inexact_match_is_low_priority);
check_relevance_for_kinds(
r#"
struct S;
impl S {
fn f(&self) {}
}
fn main() {
S.$0
}
"#,
&[CompletionItemKind::Snippet, CompletionItemKind::SymbolKind(SymbolKind::Method)],
expect![[r#"
me f() fn(&self) []
sn box Box::new(expr) []
sn call function(expr) []
sn const const {} []
sn dbg dbg!(expr) []
sn dbgr dbg!(&expr) []
sn deref *expr []
sn let let []
sn letm let mut []
sn match match expr {} []
sn ref &expr []
sn refm &mut expr []
sn return return expr []
sn unsafe unsafe {} []
"#]],
);
}
#[test]
fn flyimport_reduced_relevance() {
check_relevance(
r#"
mod std {
pub mod io {
pub trait BufRead {}
pub struct BufReader;
pub struct BufWriter;
}
}
struct Buffer;
fn f() {
Buf$0
}
"#,
expect![[r#"
st Buffer Buffer []
fn f() fn() []
md std:: []
tt BufRead [requires_import]
st BufReader BufReader [requires_import]
st BufWriter BufWriter [requires_import]
"#]],
);
}
#[test]
/// Issue: https://github.com/rust-lang/rust-analyzer/issues/18554
fn float_consts_relevance() {
check_relevance(
r#"
//- minicore: float_consts
fn main() {
let x = f32::INF$0
}
"#,
expect![[r#"
ct INFINITY pub const INFINITY: f32 []
ct NEG_INFINITY pub const NEG_INFINITY: f32 []
ct INFINITY f32 [requires_import+deprecated]
ct NEG_INFINITY f32 [requires_import+deprecated]
"#]],
);
check_relevance(
r#"
//- minicore: float_consts
fn main() {
let x: f32 = f32::INF$0
}
"#,
expect![[r#"
ct INFINITY pub const INFINITY: f32 [type]
ct NEG_INFINITY pub const NEG_INFINITY: f32 [type]
ct INFINITY f32 [type+requires_import+deprecated]
ct NEG_INFINITY f32 [type+requires_import+deprecated]
"#]],
);
}
#[test]
fn completes_struct_with_raw_identifier() {
check_edit(
"type",
r#"
mod m { pub struct r#type {} }
fn main() {
let r#type = m::t$0;
}
"#,
r#"
mod m { pub struct r#type {} }
fn main() {
let r#type = m::r#type;
}
"#,
)
}
#[test]
fn completes_fn_with_raw_identifier() {
check_edit(
"type",
r#"
mod m { pub fn r#type {} }
fn main() {
m::t$0
}
"#,
r#"
mod m { pub fn r#type {} }
fn main() {
m::r#type();$0
}
"#,
)
}
#[test]
fn completes_macro_with_raw_identifier() {
check_edit(
"let!",
r#"
macro_rules! r#let { () => {} }
fn main() {
$0
}
"#,
r#"
macro_rules! r#let { () => {} }
fn main() {
r#let!($0)
}
"#,
)
}
#[test]
fn completes_variant_with_raw_identifier() {
check_edit(
"type",
r#"
enum A { r#type }
fn main() {
let a = A::t$0
}
"#,
r#"
enum A { r#type }
fn main() {
let a = A::r#type$0
}
"#,
)
}
#[test]
fn completes_field_with_raw_identifier() {
check_edit(
"fn",
r#"
mod r#type {
pub struct r#struct {
pub r#fn: u32
}
}
fn main() {
let a = r#type::r#struct {};
a.$0
}
"#,
r#"
mod r#type {
pub struct r#struct {
pub r#fn: u32
}
}
fn main() {
let a = r#type::r#struct {};
a.r#fn
}
"#,
)
}
#[test]
fn completes_const_with_raw_identifier() {
check_edit(
"type",
r#"
struct r#struct {}
impl r#struct { pub const r#type: u8 = 1; }
fn main() {
r#struct::t$0
}
"#,
r#"
struct r#struct {}
impl r#struct { pub const r#type: u8 = 1; }
fn main() {
r#struct::r#type
}
"#,
)
}
#[test]
fn completes_type_alias_with_raw_identifier() {
check_edit(
"type type",
r#"
struct r#struct {}
trait r#trait { type r#type; }
impl r#trait for r#struct { type t$0 }
"#,
r#"
struct r#struct {}
trait r#trait { type r#type; }
impl r#trait for r#struct { type r#type = $0; }
"#,
)
}
#[test]
fn field_access_includes_self() {
check_edit(
"length",
r#"
struct S {
length: i32
}
impl S {
fn some_fn(&self) {
let l = len$0
}
}
"#,
r#"
struct S {
length: i32
}
impl S {
fn some_fn(&self) {
let l = self.length
}
}
"#,
)
}
#[test]
fn field_access_includes_closure_this_param() {
check_edit(
"length",
r#"
//- minicore: fn
struct S {
length: i32
}
impl S {
fn pack(&mut self, f: impl FnOnce(&mut Self, i32)) {
self.length += 1;
f(self, 3);
self.length -= 1;
}
fn some_fn(&mut self) {
self.pack(|this, n| len$0);
}
}
"#,
r#"
struct S {
length: i32
}
impl S {
fn pack(&mut self, f: impl FnOnce(&mut Self, i32)) {
self.length += 1;
f(self, 3);
self.length -= 1;
}
fn some_fn(&mut self) {
self.pack(|this, n| this.length);
}
}
"#,
)
}
#[test]
fn notable_traits_method_relevance() {
check_kinds(
r#"
#[doc(notable_trait)]
trait Write {
fn write(&self);
fn flush(&self);
}
struct Writer;
impl Write for Writer {
fn write(&self) {}
fn flush(&self) {}
}
fn main() {
Writer.$0
}
"#,
&[
CompletionItemKind::SymbolKind(SymbolKind::Method),
CompletionItemKind::SymbolKind(SymbolKind::Field),
CompletionItemKind::SymbolKind(SymbolKind::Function),
],
expect![[r#"
[
CompletionItem {
label: "flush()",
detail_left: Some(
"(as Write)",
),
detail_right: Some(
"fn(&self)",
),
source_range: 193..193,
delete: 193..193,
insert: "flush();$0",
kind: SymbolKind(
Method,
),
lookup: "flush",
detail: "fn(&self)",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: Some(
CompletionRelevanceTraitInfo {
notable_trait: true,
is_op_method: false,
},
),
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
},
CompletionItem {
label: "write()",
detail_left: Some(
"(as Write)",
),
detail_right: Some(
"fn(&self)",
),
source_range: 193..193,
delete: 193..193,
insert: "write();$0",
kind: SymbolKind(
Method,
),
lookup: "write",
detail: "fn(&self)",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: None,
is_local: false,
is_missing: false,
trait_: Some(
CompletionRelevanceTraitInfo {
notable_trait: true,
is_op_method: false,
},
),
is_name_already_imported: false,
requires_import: false,
is_private_editable: false,
postfix_match: None,
function: None,
is_skipping_completion: false,
has_local_inherent_impl: false,
is_deprecated: false,
},
},
]
"#]],
);
}
}