geldata / geldata/gel-rust

Restructure edgedb-protocol

Open
#38 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
231
Forks
30
PR merge metrics
No merged PRs in 30d

Description

I'd expose 4 public modules from edgedb-protocol:

  1. model - Types an application will need in its model
    • BigInt, Decimal
    • Duration, LocalDatetime, LocalDate, LocalTime
    • Re-export of uuid::Uuid
    • TBD: what to do about Datetime vs SystemTime and json
  2. dynamic/value - Value, NamedTuple and related types which are needed to represent unknown edgedb data at runtime
  3. serialization - traits for serialization, de-serialization (currently Queryable) and related types
  4. messages - probably should split this one into a separate crate (or rather move the rest to a separate crate like edgedb-data)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names the edgedb-protocol crate and proposes public model, dynamic/value, serialization, and messages modules. Start by inspecting the crate's current module and export layout, then review how Value, NamedTuple, Queryable, and the listed model types are organized. Done requires an agreed module structure and a decision on the Datetime/SystemTime, json, and messages-crate questions.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.