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.
 */
pub(crate) trait SliceCopyOps<T> {
  /// Copies elements from a source slice (`src`) into the current slice
  /// (`self`) starting at the specified offset.
  ///
  /// # Parameters
  /// - `self`: The destination mutable slice where the elements will be
  ///   copied to.
  /// - `src`: The source slice containing the elements to copy.
  /// - `Offset`: The starting position in the destination slice where the
  ///   copy begins.
  ///
  /// # Panics
  /// This function does not panic during runtime in release builds. However,
  /// it includes a `debug_assert!` in debug mode to ensure that `offset +
  /// src.len()` does not exceed the length of the destination slice (`self`).
  /// If the assertion fails, it indicates an out-of-bounds access.
  ///
  /// # Safety
  /// This function uses `unsafe` code to call
  /// [`std::ptr::copy_nonoverlapping`], which performs unchecked memory
  /// operations. You must ensure that:
  /// - The destination slice has enough space to accommodate the copied
  ///   elements.
  /// - The `src` and the destination slice (from `offset`) do not overlap.
  fn copy_from(&mut self, src: &[T], offset: usize);
}

impl<T> SliceCopyOps<T> for Vec<T> {
  #[inline]
  fn copy_from(&mut self, src: &[T], offset: usize) {
    self.as_mut_slice().copy_from(src, offset)
  }
}
impl<T> SliceCopyOps<T> for [T] {
  fn copy_from(&mut self, src: &[T], offset: usize) {
    debug_assert!(
      offset + src.len() <= self.len(),
      "Copy out of bounds: offset={}, src_len={}, buffer_len={}",
      offset,
      src.len(),
      self.len()
    );

    unsafe {
      std::ptr::copy_nonoverlapping(src.as_ptr(), self.as_mut_ptr().add(offset), src.len());
    }
  }
}