1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::core::index::index_reader_context::{IRCLeafReader, IndexReaderContext};
use crate::core::index::leaf_reader_context::LeafReaderContext;
use crate::core::util::error::lucene_error::Result;
use std::sync::Arc;
/// Trait defining whether an object can be cached against a [`LeafReader`](crate::core::index::leaf_reader::LeafReader).
///
/// Objects that depend only on segment-immutable structures such as Points or postings lists can
/// just return `Ok(true)` from [`SegmentCacheable::is_cacheable`].
///
/// Objects that depend on doc values should return
/// [`DocValues::is_cacheable`](crate::core::index::doc_values::DocValues::is_cacheable), which will check to see if the doc values
/// fields have been updated. Updated doc values fields are not suitable for cacheing.
///
/// Objects that are not segment-immutable, such as those that rely on global statistics or
/// scores, should return `false`.
pub trait SegmentCacheable<IRC: IndexReaderContext> {
/// Returns `Ok(true)` if the object can be cached against a given leaf.
fn is_cacheable(&self, ctx: &LeafReaderContext<IRCLeafReader<IRC>>) -> Result<bool>;
}
impl<IRC, T> SegmentCacheable<IRC> for Arc<T>
where
IRC: IndexReaderContext,
T: SegmentCacheable<IRC>,
{
fn is_cacheable(&self, ctx: &LeafReaderContext<IRCLeafReader<IRC>>) -> Result<bool> {
self.as_ref().is_cacheable(ctx)
}
}
impl<IRC, T> SegmentCacheable<IRC> for Box<T>
where
IRC: IndexReaderContext,
T: SegmentCacheable<IRC> + ?Sized,
{
fn is_cacheable(&self, ctx: &LeafReaderContext<IRCLeafReader<IRC>>) -> Result<bool> {
self.as_ref().is_cacheable(ctx)
}
}