rlucene 0.1.0-alpha.3

A Rust port of Apache Lucene, a full-text search engine library
Documentation
/*
 * 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::store::DataOutput;
use crate::core::store::byte_buffers_data_input::ByteBuffersDataInput;
use crate::core::util::close::Closeable;
use crate::core::util::error::lucene_error::Result;

/// A data compressor.
pub trait Compressor: Closeable {
  /// Compress bytes into `out`. It is the responsibility of the compressor to
  /// add all necessary information so that a [`Decompressor`](crate::core::codecs::compression::decompressor::Decompressor) will know
  /// when to stop decompressing bytes from the stream.
  fn compress<DO>(
    &mut self,
    buffers_input: &mut ByteBuffersDataInput<&[u8]>,
    out: &mut DO,
  ) -> Result<()>
  where
    DO: DataOutput;
}