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
/*
* 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::sync::Arc;
use crate::core::index::segment_info::SegmentInfo;
use crate::core::store::IOContext;
use crate::core::store::directory::Directory;
use crate::core::util::StringHelper;
use crate::core::util::error::lucene_error::Result;
/// Expert: Controls the format of the [`SegmentInfo`] (segment metadata file).
///
/// # See Also
/// - [`SegmentInfo`]
///
/// # Note
/// This is considered experimental and may change in future versions.
pub trait SegmentInfoFormat {
/// Read [`SegmentInfo`] data from a directory.
///
/// # Arguments
///
/// * `directory` - The directory to read from.
/// * `segment_name` - The name of the segment to read.
/// * `segment_id` - The expected identifier for the segment.
/// * `context` - The IO context.
///
/// # Errors
///
/// Returns an error if an I/O error occurs.
fn read<D>(
&self,
directory: Arc<D>,
segment_name: &str,
segment_id: &[u8; StringHelper::ID_LENGTH],
context: &IOContext,
) -> Result<SegmentInfo<D>>
where
D: Directory;
/// Write [`SegmentInfo`] data.
///
/// The codec must add its SegmentInfo filename(s) to `info` before doing
/// I/O.
fn write<D, D2>(
&self,
directory: &D2,
info: &mut SegmentInfo<D>,
context: &IOContext,
) -> Result<()>
where
D2: Directory;
}