Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] History API rework #747

Closed
wants to merge 37 commits into from
Closed

Conversation

ClementNerma
Copy link
Contributor

NOTE: This PR is a work-in-progress, and is not ready to be merged as-is. There are ongoing discussions about the new API design.

This PR aims to overhaul the history API of reedline in order to make it usable outside of the crate. It also aims to make it more robust, more intuitive and less error-prone.

Following discussions in #680 (original PR), #735 (discussion), also embedding future discussions for #746.

For newcomers in the discussion, please read #680 first, as it will help you understand the motivations and existing discussion behind this PR.

TODO list (includes unvoted tasks):

  • Global API rewrite
  • Introduce a new, fast history backend with all available features (e.g. sled-backed?)
  • Remove the sync API (see Sync history after each insert #746)
  • Add new documentation and add integration examples
  • Move the History::session method someplace else (to move session detection logic outside of the history implementation)

cc @stormasm @fdncred @sholderbach

@stormasm stormasm marked this pull request as draft February 7, 2024 01:44
@fdncred
Copy link
Collaborator

fdncred commented Jun 18, 2024

Seems like this won't materialize. I'm not sure we'd accept it anyway. I'd suggest smaller PRs so they're easier to review.

@fdncred fdncred closed this Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants