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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
* 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::query_timeout_impl::QueryTimeoutImpl;
use std::fmt::{Display, Formatter};
use std::sync::Arc;
/// Query timeout abstraction that controls whether a query should continue or be stopped.
///
/// Can be set to the searcher through [`IndexSearcher::set_timeout`](crate::core::search::index_searcher::IndexSearcher::set_timeout),
/// in which case bulk scoring will be time-bound.
pub trait QueryTimeout {
/// Called to determine whether to stop processing a query.
///
/// # Returns
/// `true` if the query should stop, `false` otherwise.
fn should_exit(&self) -> bool;
}
pub type DynQueryTimeout = dyn QueryTimeout + Send + Sync;
pub type CustomQueryTimeout = Box<DynQueryTimeout>;
pub enum QueryTimeoutEnum {
Builtin(QueryTimeoutImpl),
Custom(CustomQueryTimeout),
}
impl QueryTimeoutEnum {
pub fn custom<T>(t: T) -> Self
where
T: QueryTimeout + Send + Sync + 'static,
{
Self::Custom(Box::new(t))
}
}
impl Display for QueryTimeoutEnum {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match self {
Self::Builtin(inner) => write!(f, "{}", inner),
Self::Custom(_) => write!(f, "CustomQueryTimeout"),
}
}
}
impl QueryTimeout for QueryTimeoutEnum {
fn should_exit(&self) -> bool {
match self {
Self::Builtin(inner) => inner.should_exit(),
Self::Custom(inner) => inner.should_exit(),
}
}
}
impl<T> QueryTimeout for Arc<T>
where
T: QueryTimeout,
{
fn should_exit(&self) -> bool {
(**self).should_exit()
}
}