rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

note about performance

Browse Source
This commit is contained in:
Aleksey Kladov
2019-01-13 17:13:54 +03:00
parent ff09d15124
commit c46e0300e6
1 changed files with 18 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
editors/README.md
View File

@@ -9,7 +9,7 @@ $ cargo install-code
$ rustup component add rust-src $ rustup component add rust-src
``` ```
This will run `cargo install --packge ra_lsp_server` to install the server This will run `cargo install --package ra_lsp_server` to install the server
binary into `~/.cargo/bin`, and then will build and install plugin from binary into `~/.cargo/bin`, and then will build and install plugin from
`editors/code`. See `editors/code`. See
[this](https://github.com/rust-analyzer/rust-analyzer/blob/0199572a3d06ff66eeae85a2d2c9762996f0d2d8/crates/tools/src/main.rs#L150) [this](https://github.com/rust-analyzer/rust-analyzer/blob/0199572a3d06ff66eeae85a2d2c9762996f0d2d8/crates/tools/src/main.rs#L150)
@@ -18,9 +18,9 @@ bugs!
It's better to remove existing Rust plugins to avoid interference. It's better to remove existing Rust plugins to avoid interference.
## Rust Analyzer Specifc Features ## Rust Analyzer Specific Features
These features are implemented as extensions to the langauge server protocol. These features are implemented as extensions to the language server protocol.
They are more experimental in nature and work only with VS Code. They are more experimental in nature and work only with VS Code.
### Syntax highlighting ### Syntax highlighting
@@ -36,7 +36,7 @@ symbols can be used to narrow down the search. Specifically,
- `#Foo` searches for `Foo` type in the current workspace - `#Foo` searches for `Foo` type in the current workspace
- `#foo#` searches for `foo` function in the current workspace - `#foo#` searches for `foo` function in the current workspace
- `#Foo*` searches for `Foo` type among dependencies, excluding `stdlib` - `#Foo*` searches for `Foo` type among dependencies, excluding `stdlib`
- `#foo#*` seaches for `foo` function among dependencies. - `#foo#*` searches for `foo` function among dependencies.
That is, `#` switches from "types" to all symbols, `*` switches from the current That is, `#` switches from "types" to all symbols, `*` switches from the current
workspace to dependencies. workspace to dependencies.
@@ -196,7 +196,8 @@ use algo::{<|>visitor::{Visitor, visit}};
falls back to heuristic name matching for other things for the time being. falls back to heuristic name matching for other things for the time being.
* **Completion**: completes paths, including dependencies and standard library. * **Completion**: completes paths, including dependencies and standard library.
Does not handle glob imports and macros. Completes fields and inherent methods Does not handle glob imports and macros. Completes fields and inherent
methods.
* **Outline** <kbd>alt+shift+o</kbd> * **Outline** <kbd>alt+shift+o</kbd>
@@ -216,4 +217,14 @@ use algo::{<|>visitor::{Visitor, visit}};
* **Diagnostics** * **Diagnostics**
- missing module for `mod foo;` with a fix to create `foo.rs`. - missing module for `mod foo;` with a fix to create `foo.rs`.
- struct field shorthand - struct field shorthand
- unnessary braces in use item - unnecessary braces in use item
## Performance
Rust Analyzer is expected to be pretty fast. Specifically, the initial analysis
of the project (i.e, when you first invoke completion or symbols) typically
takes dozen of seconds at most. After that, everything is supposed to be more or
less instant. However currently all analysis results are kept in memory, so
memory usage is pretty high. Working with `rust-lang/rust` repo, for example,
needs about 5 gigabytes of ram.