Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roogle-rs/roogle

A Rust API search engine
https://github.com/roogle-rs/roogle

rust search-engine types

Last synced: 14 days ago
JSON representation

A Rust API search engine

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)