https://github.com/roogle-rs/roogle
A Rust API search engine
https://github.com/roogle-rs/roogle
rust search-engine types
Last synced: 3 months ago
JSON representation
A Rust API search engine
- Host: GitHub
- URL: https://github.com/roogle-rs/roogle
- Owner: roogle-rs
- License: apache-2.0
- Created: 2021-06-07T09:09:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T04:31:36.000Z (11 months ago)
- Last Synced: 2024-10-30T18:42:50.728Z (8 months ago)
- Topics: rust, search-engine, types
- Language: Rust
- Homepage: https://roogle.hkmatsumoto.com
- Size: 13.6 MB
- Stars: 398
- Watchers: 6
- Forks: 16
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Roogle
Roogle is a Rust API search engine, which allows you to search functions by names and type signatures.
## Progress
### Available Queries
- [x] Function queries
- [x] Method queries
### Available Types to Query
- [x] Primitive types
- [ ] Generic types
- [x] Without bounds and where predicates (e.g., ``)
- [ ] With bounds (e.g., ``)
- [ ] With where predicates
- [x] Custom types
- [x] Without generic args (e.g., `IpAddr`)
- [x] With generic args (e.g., `Vec`, `Option`)
- [ ] Other types
## Example
```sh
$ cargo r --release
# Then, on another shell session, run:
$ curl -X GET \
-d "fn (Option>) -> Result, E>>" \
"localhost:8000/search?scope=set:libstd"
```
## Example with Docker
```sh
$ docker-compose up
# Then, on another shell session, run:
$ curl -X GET \
-d "fn (Option>) -> Result, E>>" \
"localhost:8000/search?scope=set:libstd"
```
## Query Syntax
- `fn f(type) -> type`
- `fn (type) -> type`
- `fn(type) -> type`
- `(type) -> type`
## Related Project
- [cargo-roogle](https://github.com/roogle-rs/cargo-roogle)