TimelyDataflow / TimelyDataflow/timely-dataflow

Remove `Core` variants of various types

Open
#510 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
3.6k
Forks
293
Avg merge
14h 46m
Merged PRs (30d)
4

Description

We added several Core variants of types to support different container types. For example, Stream<G, D> is really a StreamCore<G, Vec<D>>. We should remove the Core variants and make them the default instead.

This is a breaking change, but it seems we have sufficient experience with the container abstraction that we can make the container type with its contents to the default stream element.

The following types need to be adjusted:

  • StreamCore
  • TeeCore
  • EventProducerCore
  • EventConsumerCore
  • BundleCore
  • ParallelizationContractCore
  • ExchangeCore
  • BufferCore
  • AutoflushSessionCore
  • CounterCore
  • feedback::HandleCore
  • input::HandleCore
  • UnorderedHandleCore
  • EventIteratorCore
  • EventPusherCore
  • EventLinkCore
  • EventWriterCore
  • EventReaderCore
  • InputHandleCore
  • FrontierdInputHandleCore
  • OutputHandleCore

Contributor guide

Open the contributing guide

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

Start by locating the listed Core types throughout the Rust crate and compare each with its corresponding non-Core API, beginning with StreamCore and Stream. Trace how container types and their contents are represented across the affected APIs. Done means all listed Core variants are removed or made the default while preserving the intended container abstraction as a breaking API change.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
distributed-systems
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.