Add support for using tinysearch as a library from Rust #184
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tation This refactoring introduces a clean, well-documented public API while maintaining backward compatibility with existing CLI functionality: - Created api module with Post trait and BasicPost implementation for flexible post types - Added TinySearch struct with builder pattern for configuration and search operations - Moved public API types to dedicated module with comprehensive rustdoc documentation - Added complete library usage examples for basic and advanced use cases - Created detailed LIBRARY_USAGE.md documentation with migration guide - Updated dependencies to support library functionality - Maintained full CLI compatibility and all existing functionality
- Added concise library usage section to README - Marked library API as experimental with API stability warning - Removed separate LIBRARY_USAGE.md file - Referenced example directories for detailed usage
… for better indexing and search capabilities
- Updated test_generate_filters to use String::new() instead of None for metadata - This fixes CI compilation error where PostId expects String but test provided Option<String> - All tests now pass with the new HashMap<String, String> metadata format
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This refactoring extends the public API while maintaining backward compatibility with existing CLI functionality:
Posttrait and aBasicPostimplementation for flexible post typesTinySearchstruct with builder pattern for configuration and search operationsCloses #183