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

Improve traits and document them #46

Merged
merged 2 commits into from
Jan 30, 2025
Merged

Conversation

faassen
Copy link
Collaborator

@faassen faassen commented Jan 29, 2025

I do the following:

  • document the search method on the FMIndexBackend trait

  • make the len() method public on the FMIndexBackend trait as I think it may be useful to end-users.

  • Introduce a HeapSize trait so we can get the heap size of an index generically

  • Introduce API tests that exercise the API through the traits, to make sure I got them right (it's easy to get into infinite recursion; only fixed once I refined the trait bounds for Character and Converter).

  • Remove the SearchIndex struct in favor using the FMIndexBackend trait as discussed.

@faassen faassen requested a review from ajalab January 29, 2025 14:35
Copy link
Owner

@ajalab ajalab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@faassen faassen merged commit c493db1 into ajalab:master Jan 30, 2025
2 checks passed
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.

2 participants