`edgedb` crate structure
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 231
- Forks
- 30
- PR merge metrics
- No merged PRs in 30d
Description
We has always wanted to expose bindings under edgedb crate instead of the edgedb-tokio/whatever. But the structure of that is not very clear. Here is a sketch of my current thinking.
- Expose
edgedb::model,edgedb::error, and whatever is needed for derive macros. - Feature
tokio: exposesedgedb::tokio - Feature
blocking: exposesedgedb::blocking(which probably a blocking wrapper around tokio) - We might have
default-tokioanddefault-blockingclient which expose respective clients to the top-level namespaceedgedb::tokio::Client -> edgedb::client,edgedb::blocking::Client -> edgedb::Client. - Potentically async-std/glommio or whatever new runtime can be done via it's own crate and brought here via feature flag. Also blocking implementation that doesn't depend on tokio could be implemented in the future too.
Ideally when async traits arrive to the stable Rust here is how it should work:
- There is an
edgedb-asynccrate which contains traits for executing queries - Libraries (which are not end-user apps) depend on
edgedb-modelandedgedb-async, but notedgedbcrate (it's unclear how that would work withedgedb-derive, though). - When we bump major version of
edgedbonly app could be updated - When we bump major version of
edgedb-modelandedgedb-asyncwe do adapters that allow libraries using older versions to work (i.e. transform to new types, seelogcrate for an inspiration)
But I'm not sure whether this is practical enough, and/or when this will become practical.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by mapping the existing edgedb, edgedb-tokio, and related crates, including their public modules and feature flags. Compare the current structure with the proposed edgedb::model, edgedb::error, edgedb::tokio, and edgedb::blocking namespaces. Done requires an agreed crate and feature architecture, not just an isolated code edit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100