Update the fetcher comments

This commit is contained in:
Kerollmops 2021-03-10 10:56:26 +01:00
parent d301859bbd
commit 54b97ed8e1
No known key found for this signature in database
GPG Key ID: 92ADA4E935E71FA4

View File

@ -8,12 +8,12 @@ use crate::search::query_tree::Operation;
use crate::search::WordDerivationsCache; use crate::search::WordDerivationsCache;
use super::{resolve_query_tree, Candidates, Criterion, CriterionResult, Context}; use super::{resolve_query_tree, Candidates, Criterion, CriterionResult, Context};
/// The result of a call to the parent criterion. /// The result of a call to the fetcher.
#[derive(Debug, Clone, PartialEq)] #[derive(Debug, Clone, PartialEq)]
pub struct FetcherResult { pub struct FetcherResult {
/// The query tree that must be used by the children criterion to fetch candidates. /// The query tree corresponding to the current bucket of the last criterion.
pub query_tree: Option<Operation>, pub query_tree: Option<Operation>,
/// The candidates that this criterion is allowed to return subsets of. /// The candidates of the current bucket of the last criterion.
pub candidates: RoaringBitmap, pub candidates: RoaringBitmap,
/// Candidates that comes from the current bucket of the initial criterion. /// Candidates that comes from the current bucket of the initial criterion.
pub bucket_candidates: RoaringBitmap, pub bucket_candidates: RoaringBitmap,