Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-09-21 06:51:57 +00:00
Code Issues Projects Releases Packages Wiki Activity

IDE API

Browse source
This commit is contained in:
Aleksey Kladov 2020-06-08 12:52:28 +02:00
parent d8552d114c
commit ee8dec5dc1
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/dev/README.md
View file

@ -268,6 +268,13 @@ IDE assumes that all information is available at all times.
IDE should use only types from `ra_hir`, and should not depend on the underling compiler types.
`ra_hir` is a facade.
## IDE API
The main IDE crate (`ra_ide`) uses "Plain Old Data" for the API.
Rather than talking in definitions and references, it talks in Strings and textual offsets.
In general, API is centered around UI concerns -- the result of the call is what the user sees in the editor, and not what the compiler sees underneath.
The results are 100% Rust specific though.
# Logging
Logging is done by both rust-analyzer and VS Code, so it might be tricky to