ARK-Builders / ARK-Builders/ark-core

Improve `ResourceIndex::update_one()` for More Detailed Events

Open
#89 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Rust
Stars
10
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Currently, `ResourceIndex::update_one()` returns a `Result>`, which basically just includes a couple of hashsets for added and removed resources. This is simple so that it matches the return type of `update_all()`.

However, we should consider enhancing `update_one` to provide more detailed events. This could make the Track API and Watch API more powerful compared to the Reactive API. The goal is to support finer-grained events, similar to what `notify-rs` offers, including not just add/remove events but also rename and modify events.

For more context, see https://github.com/ARK-Builders/ark-core/pull/36#discussion_r1751927054

Contributor guide

Open the contributing guide

Research direction

Start by reading ResourceIndex::update_one and comparing its current result with update_all, then review the linked pull-request discussion and the Track, Watch, and Reactive API usage. The work is complete when update_one supports clearly defined fine-grained add, remove, rename, and modify events.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.