Skip to main content

Crate use_search_index

Crate use_search_index 

Source
Expand description

§use-search-index

Search-index modeling primitives for RustUse.

§Experimental

use-search-index is experimental while use-nosql remains below 0.3.0.

§Example

use use_search_index::{SearchDocumentId, SearchField, SearchIndexDocument, SearchQueryShape};

let document = SearchIndexDocument::new(SearchDocumentId::new("review_1"))
    .with_field(SearchField::new("title"), "Great service");

assert_eq!(document.fields().len(), 1);
assert_eq!(SearchQueryShape::Term.to_string(), "term");

§Scope

  • Index, document, field, term, analyzer, query-shape, sort, and filter labels.
  • Small search-index document containers.

§Non-goals

  • Search engine implementation.
  • Elasticsearch, OpenSearch, or vendor clients.
  • Query execution.

§License

Licensed under either Apache-2.0 or MIT.

Structs§

IndexName
A search index name.
SearchAnalyzer
A search analyzer label.
SearchDocumentId
A search index document identifier.
SearchField
A searchable field name.
SearchFilter
A search filter label or expression shape.
SearchIndexDocument
A modeled search-index document.
SearchSort
A sort instruction for search results.
SearchTerm
A search term.

Enums§

SearchQueryShape
A conservative search query shape label.