Module swiftide::query

Query your indexed data with a transforming pipeline

Modules

• answers
  Given a query, generate an answer
• evaluators
  This module contains evaluators for evaluating the quality of a pipeline.
• query_transformers
  Transform queries that are yet to be made
• response_transformers
  Transform retrieved queries
• search_strategies
• states
  States of a query

Structs

• Pipeline
  The starting point of a query pipeline
• Query
  A query is the main object going through a query pipeline
• QueryBuilder
  Builder for Query.
• QueryStream
  Internally used by a query pipeline

Enums

• QueryBuilderError
  Error type for QueryBuilder
• QueryEvaluation
  Wraps a query for evaluation. Used by the [EvaluateQuery] trait.
• TransformationEvent
  Records changes to a query

Traits

• Answer
  Can answer the original query
• EvaluateQuery
  Evaluates a query
• Retrieve
  Can retrieve documents given a SearchStrategy
• SearchStrategy
  A search strategy for the query pipeline
• StreamExt
  An extension trait for Streams that provides a variety of convenient combinator functions.
• TransformQuery
  Can transform queries before retrieval
• TransformResponse
  Can transform a response after retrieval
• TryStreamExt
  Adapters specific to Result-returning streams