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
/*
* 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 std::fmt::{Display, Formatter};
use std::hash::Hash;
use crate::core::search::field_comparator::FieldComparator;
use crate::core::search::pruning::Pruning;
use crate::core::util::error::lucene_error::Result;
/// Provides a [`FieldComparator`]
/// for custom field sorting.
///
/// # Lucene Experimental
/// This API is experimental and may change in future versions.
pub trait FieldComparatorSource: Display + Clone {
/// Creates a comparator for the field in the given index.
///
/// # Arguments
/// - `field_name`: The name of the field to create a comparator for.
/// - `num_hits`: The number of hits.
/// - `pruning`: The pruning strategy to use.
/// - `reversed`: Whether the sorting should be reversed.
///
/// # Returns
/// A new [`FieldComparator`] instance.
///
/// # Errors
/// Returns an error if the comparator could not be created due to I/O
/// issues or invalid parameters.
fn new_comparator<F>(
&self,
field_name: &str,
num_hits: usize,
pruning: Pruning,
reversed: bool,
) -> Result<F>
where
F: FieldComparator;
}
#[derive(Clone, PartialEq, Eq, Hash)]
pub enum FieldComparatorSourceEnum {}
impl Display for FieldComparatorSourceEnum {
fn fmt(&self, _f: &mut Formatter<'_>) -> std::fmt::Result {
todo!()
}
}